From 6b223cebeb14e8fa9a2d7acb61636e30dd308b48 Mon Sep 17 00:00:00 2001 From: Vlad Emelianov Date: Tue, 1 Feb 2022 13:03:41 +0300 Subject: [PATCH] Rename branch to main --- .github/workflows/on_push_coverage.yml | 2 +- .github/workflows/on_release.yml | 2 +- README.md | 34 ++++----- docs/README.md | 34 ++++----- docs/examples/comment_typed.md | 12 +-- docs/examples/expressions.md | 2 +- docs/examples/google_docstrings.md | 10 +-- docs/examples/index.md | 2 +- docs/examples/main_example.md | 10 +-- docs/examples/pep257_docstrings.md | 8 +- docs/examples/pyi_typed.md | 8 +- docs/examples/rst_docstrings.md | 10 +-- docs/examples/sphinx_docstrings.md | 10 +-- docs/examples/typed.md | 14 ++-- docs/handsdown/assets/index.md | 2 +- .../ast_parser/analyzers/base_analyzer.md | 4 +- .../ast_parser/analyzers/class_analyzer.md | 14 ++-- .../analyzers/expression_analyzer.md | 76 +++++++++---------- .../ast_parser/analyzers/function_analyzer.md | 12 +-- docs/handsdown/ast_parser/analyzers/index.md | 2 +- .../ast_parser/analyzers/module_analyzer.md | 16 ++-- docs/handsdown/ast_parser/enums.md | 6 +- docs/handsdown/ast_parser/index.md | 2 +- .../ast_parser/module_record_list.md | 12 +-- .../node_records/argument_record.md | 10 +-- .../node_records/attribute_record.md | 10 +-- .../ast_parser/node_records/class_record.md | 12 +-- .../node_records/expression_record.md | 6 +- .../node_records/function_record.md | 8 +- .../ast_parser/node_records/import_record.md | 8 +- .../ast_parser/node_records/index.md | 2 +- .../ast_parser/node_records/module_record.md | 14 ++-- .../ast_parser/node_records/node_record.md | 20 ++--- .../ast_parser/node_records/text_record.md | 6 +- docs/handsdown/ast_parser/smart_ast.md | 2 +- docs/handsdown/ast_parser/type_defs.md | 2 +- docs/handsdown/cli_parser.md | 16 ++-- docs/handsdown/generator.md | 16 ++-- docs/handsdown/index.md | 16 ++-- docs/handsdown/loader.md | 14 ++-- docs/handsdown/main.md | 6 +- docs/handsdown/md_document.md | 44 +++++------ docs/handsdown/module.md | 2 +- docs/handsdown/processors/base.md | 6 +- docs/handsdown/processors/index.md | 2 +- docs/handsdown/processors/pep257.md | 4 +- docs/handsdown/processors/rst.md | 4 +- docs/handsdown/processors/section_map.md | 22 +++--- docs/handsdown/processors/smart.md | 6 +- docs/handsdown/settings.md | 2 +- docs/handsdown/utils/docstring_formatter.md | 6 +- docs/handsdown/utils/import_string.md | 22 +++--- docs/handsdown/utils/indent_trimmer.md | 16 ++-- docs/handsdown/utils/index.md | 8 +- docs/handsdown/utils/logger.md | 4 +- docs/handsdown/utils/path_finder.md | 16 ++-- handsdown/README.md | 14 ++-- scripts/update_docs.sh | 4 +- 58 files changed, 327 insertions(+), 327 deletions(-) diff --git a/.github/workflows/on_push_coverage.yml b/.github/workflows/on_push_coverage.yml index f86d6a68..710875ef 100644 --- a/.github/workflows/on_push_coverage.yml +++ b/.github/workflows/on_push_coverage.yml @@ -3,7 +3,7 @@ name: Send coverage report on: push: branches: - - master + - main paths: - handsdown/** - tests/** diff --git a/.github/workflows/on_release.yml b/.github/workflows/on_release.yml index f1b247a7..3c5a3d6c 100644 --- a/.github/workflows/on_release.yml +++ b/.github/workflows/on_release.yml @@ -52,7 +52,7 @@ jobs: git add setup.cfg git commit -m "Release ${VERSION}" git push https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git --tags - git push https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git HEAD:master + git push https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git HEAD:main - name: Publish to PyPI env: TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} diff --git a/README.md b/README.md index 5bf56843..f57797b1 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/handsdown.svg?color=blue&style=for-the-badge)](https://pypi.org/project/handsdown) ![PyPI - Downloads](https://img.shields.io/pypi/dm/handsdown?color=blue&style=for-the-badge) [![Build Status](https://img.shields.io/travis/vemel/handsdown.svg?style=for-the-badge)](https://travis-ci.org/vemel/handsdown) -[![Code Coverage](https://img.shields.io/codecov/c/gh/vemel/handsdown.svg?style=for-the-badge)](https://codecov.io/gh/vemel/handsdown/tree/master/handsdown) +[![Code Coverage](https://img.shields.io/codecov/c/gh/vemel/handsdown.svg?style=for-the-badge)](https://codecov.io/gh/vemel/handsdown/tree/main/handsdown) [![Docs](https://img.shields.io/readthedocs/handsdown.svg?color=blue&style=for-the-badge)](https://handsdown.readthedocs.io/) Python docstring-based documentation generator for lazy perfectionists. @@ -35,11 +35,11 @@ Python docstring-based documentation generator for lazy perfectionists. docstrings support. All of them are converted to a valid Markdown. - Works with [Django](https://www.djangoproject.com/) and [Flask](https://palletsprojects.com/p/flask/) apps - Can be used locally, or - [right on GitHub](https://github.com/vemel/handsdown/blob/master/docs/README.md) or even deployed on + [right on GitHub](https://github.com/vemel/handsdown/blob/main/docs/README.md) or even deployed on [GitHub Pages](https://vemel.github.io/handsdown/) and [Read the Docs](https://handsdown.readthedocs.io/)! - Signatures for every class, function, property and method. - Support for type annotations. Even for the ones from the `__future__`! -- Nice list of all modules in [Modules](https://github.com/vemel/handsdown/blob/master/docs/MODULES.md) +- Nice list of all modules in [Modules](https://github.com/vemel/handsdown/blob/main/docs/MODULES.md) - Gather all scattered `README.md` in submodules to one place - Find related source code from every doc section. - Make links by just adding `module.import.String` to docs. @@ -66,13 +66,13 @@ And probably *do not* if you: ## Examples - [All documentation](https://vemel.github.io/handsdown/) in this project -- [Main](https://github.com/vemel/handsdown/blob/master/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/main_example.md) -- [RST docstrings](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/rst_docstrings.md) -- [Google docstrings](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/google_docstrings.md) -- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/pep257_docstrings.md) -- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/sphinx_docstrings.md) -- [Type annotations](https://github.com/vemel/handsdown/blob/master/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/typed.md) -- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/comment_typed.md) +- [Main](https://github.com/vemel/handsdown/blob/main/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/main_example.md) +- [RST docstrings](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/rst_docstrings.md) +- [Google docstrings](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/google_docstrings.md) +- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/pep257_docstrings.md) +- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/sphinx_docstrings.md) +- [Type annotations](https://github.com/vemel/handsdown/blob/main/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/typed.md) +- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/comment_typed.md) ## Usage @@ -129,19 +129,19 @@ for [GitHub Pages](https://pages.github.com/), so you just need to setup your GitHub repository. ```bash -# Generate documentation that points to master branch +# Generate documentation that points to main branch # do not use custom output location, as `GitHub Pages` # works only with `docs` directory handsdown --external `git config --get remote.origin.url` # or specify GitHub url directly -handsdown --external https://github.com///blob/master/ +handsdown --external https://github.com// --branch main ``` - Generate documentation with `--external` flag as shown above, do not use `--output` flag, only `docs` folder is supported by `GitHub Pages` -- Commit and push all changes a to `master` branch. -- Set your GitHub project `Settings` > `GitHub Pages` > `Source` to `master branch /docs folder` +- Commit and push all changes a to `main` branch. +- Set your GitHub project `Settings` > `GitHub Pages` > `Source` to `main branch /docs folder` All set! You can change `docs/_config.yml` to add your own touch. @@ -162,7 +162,7 @@ for [Read the Docs](https://readthedocs.org/), so you just need to to add your GitHub repository to `Read the Docs`. ```bash -# Generate documentation that points to master branch +# Generate documentation that points to main branch # do not use custom output location, as `GitHub Pages` # works only with `docs` directory handsdown --external `git config --get remote.origin.url` @@ -173,7 +173,7 @@ handsdown --external https://github.com/// - Generate documentation with `--external` flag as shown above, do not use `--output` flag, only `docs` folder is supported by `Read the Docs` -- Commit and push all changes a to `master` branch. +- Commit and push all changes a to `main` branch. - Add your repository on [Read the Docs](https://readthedocs.org/) All set! You can change `.readthedocs.yml` and `mkdocs.yml` to add your own touch. @@ -181,7 +181,7 @@ All set! You can change `.readthedocs.yml` and `mkdocs.yml` to add your own touc ### 📋 Build static HTML ```bash -# Generate documentation that points to master branch +# Generate documentation that points to main branch # with source links pointing to your repository # this command also creates `mkdocs.yml` handsdown --external `git config --get remote.origin.url` diff --git a/docs/README.md b/docs/README.md index cb1cb299..afe7ab30 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/handsdown.svg?color=blue&style=for-the-badge)](https://pypi.org/project/handsdown) ![PyPI - Downloads](https://img.shields.io/pypi/dm/handsdown?color=blue&style=for-the-badge) [![Build Status](https://img.shields.io/travis/vemel/handsdown.svg?style=for-the-badge)](https://travis-ci.org/vemel/handsdown) -[![Code Coverage](https://img.shields.io/codecov/c/gh/vemel/handsdown.svg?style=for-the-badge)](https://codecov.io/gh/vemel/handsdown/tree/master/handsdown) +[![Code Coverage](https://img.shields.io/codecov/c/gh/vemel/handsdown.svg?style=for-the-badge)](https://codecov.io/gh/vemel/handsdown/tree/main/handsdown) [![Docs](https://img.shields.io/readthedocs/handsdown.svg?color=blue&style=for-the-badge)](https://handsdown.readthedocs.io/) Python docstring-based documentation generator for lazy perfectionists. @@ -39,11 +39,11 @@ Full Handsdown project documentation can be found in [Modules](MODULES.md#module docstrings support. All of them are converted to a valid Markdown. - Works with [Django](https://www.djangoproject.com/) and [Flask](https://palletsprojects.com/p/flask/) apps - Can be used locally, or - [right on GitHub](https://github.com/vemel/handsdown/blob/master/docs/README.md) or even deployed on + [right on GitHub](https://github.com/vemel/handsdown/blob/main/docs/README.md) or even deployed on [GitHub Pages](https://vemel.github.io/handsdown/) and [Read the Docs](https://handsdown.readthedocs.io/)! - Signatures for every class, function, property and method. - Support for type annotations. Even for the ones from the `__future__`! -- Nice list of all modules in [Modules](https://github.com/vemel/handsdown/blob/master/docs/MODULES.md) +- Nice list of all modules in [Modules](https://github.com/vemel/handsdown/blob/main/docs/MODULES.md) - Gather all scattered `README.md` in submodules to one place - Find related source code from every doc section. - Make links by just adding `module.import.String` to docs. @@ -70,13 +70,13 @@ And probably *do not* if you: ## Examples - [All documentation](https://vemel.github.io/handsdown/) in this project -- [Main](https://github.com/vemel/handsdown/blob/master/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/main_example.md) -- [RST docstrings](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/rst_docstrings.md) -- [Google docstrings](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/google_docstrings.md) -- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/pep257_docstrings.md) -- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/sphinx_docstrings.md) -- [Type annotations](https://github.com/vemel/handsdown/blob/master/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/typed.md) -- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/comment_typed.md) +- [Main](https://github.com/vemel/handsdown/blob/main/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/main_example.md) +- [RST docstrings](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/rst_docstrings.md) +- [Google docstrings](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/google_docstrings.md) +- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/pep257_docstrings.md) +- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/sphinx_docstrings.md) +- [Type annotations](https://github.com/vemel/handsdown/blob/main/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/typed.md) +- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/comment_typed.md) ## Usage @@ -133,19 +133,19 @@ for [GitHub Pages](https://pages.github.com/), so you just need to setup your GitHub repository. ```bash -# Generate documentation that points to master branch +# Generate documentation that points to main branch # do not use custom output location, as `GitHub Pages` # works only with `docs` directory handsdown --external `git config --get remote.origin.url` # or specify GitHub url directly -handsdown --external https://github.com///blob/master/ +handsdown --external https://github.com// --branch main ``` - Generate documentation with `--external` flag as shown above, do not use `--output` flag, only `docs` folder is supported by `GitHub Pages` -- Commit and push all changes a to `master` branch. -- Set your GitHub project `Settings` > `GitHub Pages` > `Source` to `master branch /docs folder` +- Commit and push all changes a to `main` branch. +- Set your GitHub project `Settings` > `GitHub Pages` > `Source` to `main branch /docs folder` All set! You can change `docs/_config.yml` to add your own touch. @@ -166,7 +166,7 @@ for [Read the Docs](https://readthedocs.org/), so you just need to to add your GitHub repository to `Read the Docs`. ```bash -# Generate documentation that points to master branch +# Generate documentation that points to main branch # do not use custom output location, as `GitHub Pages` # works only with `docs` directory handsdown --external `git config --get remote.origin.url` @@ -177,7 +177,7 @@ handsdown --external https://github.com/// - Generate documentation with `--external` flag as shown above, do not use `--output` flag, only `docs` folder is supported by `Read the Docs` -- Commit and push all changes a to `master` branch. +- Commit and push all changes a to `main` branch. - Add your repository on [Read the Docs](https://readthedocs.org/) All set! You can change `.readthedocs.yml` and `mkdocs.yml` to add your own touch. @@ -185,7 +185,7 @@ All set! You can change `.readthedocs.yml` and `mkdocs.yml` to add your own touc ### 📋 Build static HTML ```bash -# Generate documentation that points to master branch +# Generate documentation that points to main branch # with source links pointing to your repository # this command also creates `mkdocs.yml` handsdown --external `git config --get remote.origin.url` diff --git a/docs/examples/comment_typed.md b/docs/examples/comment_typed.md index b2a633fc..a5a0400c 100644 --- a/docs/examples/comment_typed.md +++ b/docs/examples/comment_typed.md @@ -1,6 +1,6 @@ # PEP 484 - comment-based type annotations examples -> Auto-generated documentation for [examples.comment_typed](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py) module. +> Auto-generated documentation for [examples.comment_typed](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / PEP 484 - comment-based type annotations examples - [Links](#links) @@ -16,7 +16,7 @@ ## MyValue -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py#L12) ```python class MyValue(): @@ -25,7 +25,7 @@ class MyValue(): ## Typed -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py#L18) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py#L18) ```python class Typed(): @@ -48,7 +48,7 @@ class Typed(): ### Typed.classmethod -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py#L37) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py#L37) ```python @classmethod @@ -61,7 +61,7 @@ def classmethod(_my_value: MyValue, *_args: str, **_kwargs: Any) -> Typed: ## func -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py#L43) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py#L43) ```python def func( @@ -77,7 +77,7 @@ def func( ## func_any -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py#L48) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py#L48) ```python def func_any( diff --git a/docs/examples/expressions.md b/docs/examples/expressions.md index 5d93d7d7..5eedba09 100644 --- a/docs/examples/expressions.md +++ b/docs/examples/expressions.md @@ -1,6 +1,6 @@ # Supported expressions examples -> Auto-generated documentation for [examples.expressions](https://github.com/vemel/handsdown/blob/master/examples/expressions.py) module. +> Auto-generated documentation for [examples.expressions](https://github.com/vemel/handsdown/blob/main/examples/expressions.py) module. Test for [ExpressionAnalyzer](../handsdown/ast_parser/analyzers/expression_analyzer.md#expressionanalyzer) test. diff --git a/docs/examples/google_docstrings.md b/docs/examples/google_docstrings.md index fb57746a..3254a48c 100644 --- a/docs/examples/google_docstrings.md +++ b/docs/examples/google_docstrings.md @@ -1,6 +1,6 @@ # Google docstrings examples -> Auto-generated documentation for [examples.google_docstrings](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py) module. +> Auto-generated documentation for [examples.google_docstrings](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / Google docstrings examples - [Links](#links) @@ -17,7 +17,7 @@ ## ClassExample -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py#L13) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py#L13) ```python class ClassExample(): @@ -32,7 +32,7 @@ Google-style class example ### ClassExample().method_example -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py#L22) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py#L22) ```python def method_example(text: str = 'hello') -> int: @@ -76,7 +76,7 @@ to use the function ## function_example -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py#L56) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py#L56) ```python def function_example(arg1, arg2, arg3=None): @@ -116,7 +116,7 @@ print result ## function_with_pep484_type_annotations -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py#L87) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py#L87) ```python def function_with_pep484_type_annotations(param1: int, param2: str) -> bool: diff --git a/docs/examples/index.md b/docs/examples/index.md index 6caa1f60..bc7744bd 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,6 +1,6 @@ # Examples -> Auto-generated documentation for [examples](https://github.com/vemel/handsdown/blob/master/examples/__init__.py) module. +> Auto-generated documentation for [examples](https://github.com/vemel/handsdown/blob/main/examples/__init__.py) module. Examples of different docstring formats supported by [Handsdown](../handsdown/index.md#handsdown). Can be used as a list of supported features. diff --git a/docs/examples/main_example.md b/docs/examples/main_example.md index 4de01573..d7a388df 100644 --- a/docs/examples/main_example.md +++ b/docs/examples/main_example.md @@ -1,6 +1,6 @@ # Main Example -> Auto-generated documentation for [examples.main_example](https://github.com/vemel/handsdown/blob/master/examples/main_example.py) module. +> Auto-generated documentation for [examples.main_example](https://github.com/vemel/handsdown/blob/main/examples/main_example.py) module. This is a module docstring. It will appear in documentation. @@ -24,7 +24,7 @@ and it will be transformed to a link. ## MyClass -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/main_example.py#L54) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/main_example.py#L54) ```python class MyClass(BaseClass): @@ -43,7 +43,7 @@ This time we use RST docstrings format. ### MyClass().\_\_bool\_\_ -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/main_example.py#L92) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/main_example.py#L92) ```python def __bool__() -> bool: @@ -57,7 +57,7 @@ True if [STUFF_COUNT](#myclass) is not zero ### MyClass.do_something -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/main_example.py#L65) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/main_example.py#L65) ```python @classmethod @@ -96,7 +96,7 @@ Changed in version 1.4 ## hello -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/main_example.py#L27) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/main_example.py#L27) ```python def hello(name: str) -> str: diff --git a/docs/examples/pep257_docstrings.md b/docs/examples/pep257_docstrings.md index df2c075b..b6c1e8e7 100644 --- a/docs/examples/pep257_docstrings.md +++ b/docs/examples/pep257_docstrings.md @@ -1,6 +1,6 @@ # PEP 257 - PEP 257 and Google docstrings examples -> Auto-generated documentation for [examples.pep257_docstrings](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py) module. +> Auto-generated documentation for [examples.pep257_docstrings](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / PEP 257 - PEP 257 and Google docstrings examples - [Links](#links) @@ -14,7 +14,7 @@ ## ClassExample -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py#L11) ```python class ClassExample(): @@ -43,7 +43,7 @@ This is not a codeblock, test inside tildes rendered as it is ### ClassExample().method_example -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py#L34) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py#L34) ```python def method_example(text: str = 'hello') -> int: @@ -87,7 +87,7 @@ Description of return value ## function_example -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py#L67) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py#L67) ```python def function_example(real=0.0, imag=0.0): diff --git a/docs/examples/pyi_typed.md b/docs/examples/pyi_typed.md index d4c1e075..38bf314f 100644 --- a/docs/examples/pyi_typed.md +++ b/docs/examples/pyi_typed.md @@ -1,6 +1,6 @@ # Stub file type annotations examples -> Auto-generated documentation for [examples.pyi_typed](https://github.com/vemel/handsdown/blob/master/examples/pyi_typed.py) module. +> Auto-generated documentation for [examples.pyi_typed](https://github.com/vemel/handsdown/blob/main/examples/pyi_typed.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / Stub file type annotations examples - [Links](#links) @@ -14,7 +14,7 @@ ## MyValue -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/pyi_typed.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/pyi_typed.py#L11) ```python class MyValue(): @@ -22,7 +22,7 @@ class MyValue(): ## func -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/pyi_typed.py#L15) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/pyi_typed.py#L15) ```python def func(_list, _my_value_cls=MyValue, **_kwargs): @@ -34,7 +34,7 @@ def func(_list, _my_value_cls=MyValue, **_kwargs): ## func_any -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/pyi_typed.py#L19) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/pyi_typed.py#L19) ```python def func_any(_list, _my_value_cls=MyValue, **_kwargs): diff --git a/docs/examples/rst_docstrings.md b/docs/examples/rst_docstrings.md index 874f3cb3..3b1cf7a7 100644 --- a/docs/examples/rst_docstrings.md +++ b/docs/examples/rst_docstrings.md @@ -1,6 +1,6 @@ # PEP 287 - reStructuredText docstrings examples -> Auto-generated documentation for [examples.rst_docstrings](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py) module. +> Auto-generated documentation for [examples.rst_docstrings](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / PEP 287 - reStructuredText docstrings examples - [Links](#links) @@ -15,7 +15,7 @@ ## RSTExample -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py#L11) ```python class RSTExample(): @@ -23,7 +23,7 @@ class RSTExample(): ### RSTExample.reference -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py#L12) ```python @staticmethod @@ -59,7 +59,7 @@ print(data) ### RSTExample.replace_test -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py#L41) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py#L41) ```python @staticmethod @@ -71,7 +71,7 @@ Check if all attribute `attributes`, ``data`` and exception `Exception` in ### RSTExample.rtype_test -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py#L32) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py#L32) ```python @staticmethod diff --git a/docs/examples/sphinx_docstrings.md b/docs/examples/sphinx_docstrings.md index 22c12ef8..04682c77 100644 --- a/docs/examples/sphinx_docstrings.md +++ b/docs/examples/sphinx_docstrings.md @@ -1,6 +1,6 @@ # Sphinx docstrings examples -> Auto-generated documentation for [examples.sphinx_docstrings](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py) module. +> Auto-generated documentation for [examples.sphinx_docstrings](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / Sphinx docstrings examples - [Links](#links) @@ -15,7 +15,7 @@ ## RSTExample -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py#L11) ```python class RSTExample(): @@ -23,7 +23,7 @@ class RSTExample(): ### RSTExample.directives_test -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py#L34) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py#L34) ```python @staticmethod @@ -55,7 +55,7 @@ modules :py:mod:`zipfile`, :py:mod:`tarfile` ### RSTExample.reference -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py#L12) ```python @staticmethod @@ -91,7 +91,7 @@ Return statement ### RSTExample.version_directives_test -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py#L58) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py#L58) ```python @staticmethod diff --git a/docs/examples/typed.md b/docs/examples/typed.md index ba5a6933..3044b171 100644 --- a/docs/examples/typed.md +++ b/docs/examples/typed.md @@ -1,6 +1,6 @@ # PEP 484 - type annotations examples -> Auto-generated documentation for [examples.typed](https://github.com/vemel/handsdown/blob/master/examples/typed.py) module. +> Auto-generated documentation for [examples.typed](https://github.com/vemel/handsdown/blob/main/examples/typed.py) module. - [Handsdown](../README.md#-handsdown---python-documentation-generator) / [Modules](../MODULES.md#modules) / [Examples](index.md#examples) / PEP 484 - type annotations examples - [Links](#links) @@ -17,7 +17,7 @@ ## MyValue -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/typed.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/typed.py#L12) ```python class MyValue(): @@ -25,7 +25,7 @@ class MyValue(): ## Typed -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/typed.py#L16) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/typed.py#L16) ```python class Typed(): @@ -46,7 +46,7 @@ class Typed(): ### Typed().async_method -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/typed.py#L38) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/typed.py#L38) ```python async def async_method(_value: str) -> str: @@ -54,7 +54,7 @@ async def async_method(_value: str) -> str: ### Typed.classmethod -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/typed.py#L34) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/typed.py#L34) ```python @classmethod @@ -67,7 +67,7 @@ def classmethod(_my_value: MyValue, *_args: str, **_kwargs: Any) -> None: ## func -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/typed.py#L46) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/typed.py#L46) ```python @my_deco(key='value') @@ -84,7 +84,7 @@ def func( ## my_deco -[[find in source code]](https://github.com/vemel/handsdown/blob/master/examples/typed.py#L42) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/examples/typed.py#L42) ```python def my_deco(key): diff --git a/docs/handsdown/assets/index.md b/docs/handsdown/assets/index.md index 8665c727..7eb43123 100644 --- a/docs/handsdown/assets/index.md +++ b/docs/handsdown/assets/index.md @@ -1,5 +1,5 @@ # Assets -> Auto-generated documentation for [handsdown.assets](https://github.com/vemel/handsdown/blob/master/handsdown/assets/__init__.py) module. +> Auto-generated documentation for [handsdown.assets](https://github.com/vemel/handsdown/blob/main/handsdown/assets/__init__.py) module. - [Handsdown](../../README.md#-handsdown---python-documentation-generator) / [Modules](../../MODULES.md#modules) / [Handsdown](../index.md#handsdown) / Assets diff --git a/docs/handsdown/ast_parser/analyzers/base_analyzer.md b/docs/handsdown/ast_parser/analyzers/base_analyzer.md index b9448643..5dfcdb7e 100644 --- a/docs/handsdown/ast_parser/analyzers/base_analyzer.md +++ b/docs/handsdown/ast_parser/analyzers/base_analyzer.md @@ -1,6 +1,6 @@ # BaseAnalyzer -> Auto-generated documentation for [handsdown.ast_parser.analyzers.base_analyzer](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/base_analyzer.py) module. +> Auto-generated documentation for [handsdown.ast_parser.analyzers.base_analyzer](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/base_analyzer.py) module. Base AST analyzer. @@ -9,7 +9,7 @@ Base AST analyzer. ## BaseAnalyzer -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/base_analyzer.py#L9) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/base_analyzer.py#L9) ```python class BaseAnalyzer(ast.NodeVisitor): diff --git a/docs/handsdown/ast_parser/analyzers/class_analyzer.md b/docs/handsdown/ast_parser/analyzers/class_analyzer.md index 5b516dc4..e05d1a71 100644 --- a/docs/handsdown/ast_parser/analyzers/class_analyzer.md +++ b/docs/handsdown/ast_parser/analyzers/class_analyzer.md @@ -1,6 +1,6 @@ # ClassAnalyzer -> Auto-generated documentation for [handsdown.ast_parser.analyzers.class_analyzer](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py) module. +> Auto-generated documentation for [handsdown.ast_parser.analyzers.class_analyzer](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py) module. AST analyzer for `ast.ClassDef` records. @@ -14,7 +14,7 @@ AST analyzer for `ast.ClassDef` records. ## ClassAnalyzer -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L11) ```python class ClassAnalyzer(BaseAnalyzer): @@ -29,7 +29,7 @@ AST analyzer for `ast.ClassDef` records. ### ClassAnalyzer().generic_visit -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py#L138) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L138) ```python def generic_visit(node: ast.AST) -> None: @@ -43,7 +43,7 @@ Do nothing for unknown `ast.AST` nodes. ### ClassAnalyzer().visit_Assign -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py#L98) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L98) ```python def visit_Assign(node: ast.Assign) -> None: @@ -75,7 +75,7 @@ class MyClass: ### ClassAnalyzer().visit_AsyncFunctionDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py#L80) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L80) ```python def visit_AsyncFunctionDef(node: ast.AsyncFunctionDef) -> None: @@ -99,7 +99,7 @@ class MyClass: ### ClassAnalyzer().visit_ClassDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py#L23) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L23) ```python def visit_ClassDef(node: ast.ClassDef) -> None: @@ -126,7 +126,7 @@ def my_func(): ### ClassAnalyzer().visit_FunctionDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/class_analyzer.py#L62) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/class_analyzer.py#L62) ```python def visit_FunctionDef(node: ast.FunctionDef) -> None: diff --git a/docs/handsdown/ast_parser/analyzers/expression_analyzer.md b/docs/handsdown/ast_parser/analyzers/expression_analyzer.md index 79bd281d..936bc129 100644 --- a/docs/handsdown/ast_parser/analyzers/expression_analyzer.md +++ b/docs/handsdown/ast_parser/analyzers/expression_analyzer.md @@ -1,6 +1,6 @@ # ExpressionAnalyzer -> Auto-generated documentation for [handsdown.ast_parser.analyzers.expression_analyzer](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py) module. +> Auto-generated documentation for [handsdown.ast_parser.analyzers.expression_analyzer](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py) module. AST analyzer for `ast.expr` records. @@ -45,7 +45,7 @@ AST analyzer for `ast.expr` records. ## ExpressionAnalyzer -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L13) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L13) ```python class ExpressionAnalyzer(BaseAnalyzer): @@ -66,7 +66,7 @@ Prepares `parts` for `NodeRecord.render` method. ### ExpressionAnalyzer().generic_visit -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L782) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L782) ```python def generic_visit(node: ast.AST) -> None: @@ -82,7 +82,7 @@ Logs warning with node class. ### ExpressionAnalyzer().visit_Attribute -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L164) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L164) ```python def visit_Attribute(node: ast.Attribute) -> None: @@ -102,7 +102,7 @@ my_object.attribute ### ExpressionAnalyzer().visit_Await -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L737) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L737) ```python def visit_Await(node: ast.Await) -> None: @@ -122,7 +122,7 @@ await result ### ExpressionAnalyzer().visit_BinOp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L389) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L389) ```python def visit_BinOp(node: ast.BinOp) -> None: @@ -143,7 +143,7 @@ value + 1 ### ExpressionAnalyzer().visit_BoolOp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L410) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L410) ```python def visit_BoolOp(node: ast.BoolOp) -> None: @@ -164,7 +164,7 @@ a and b ### ExpressionAnalyzer().visit_Bytes -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L85) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L85) ```python def visit_Bytes(node: ast.Bytes) -> None: @@ -184,7 +184,7 @@ b"my_string" ### ExpressionAnalyzer().visit_Call -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L253) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L253) ```python def visit_Call(node: ast.Call) -> None: @@ -198,7 +198,7 @@ Parse info from `ast.Call` node and put it to `parts`. ### ExpressionAnalyzer().visit_Compare -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L366) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L366) ```python def visit_Compare(node: ast.Compare) -> None: @@ -219,7 +219,7 @@ value < 5 ### ExpressionAnalyzer().visit_Dict -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L342) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L342) ```python def visit_Dict(node: ast.Dict) -> None: @@ -233,7 +233,7 @@ Parse info from `ast.Dict` node and put it to `parts`. ### ExpressionAnalyzer().visit_DictComp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L646) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L646) ```python def visit_DictComp(node: ast.DictComp) -> None: @@ -253,7 +253,7 @@ Parse info from `ast.DictComp` node and put it to `parts`. ### ExpressionAnalyzer().visit_Ellipsis -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L553) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L553) ```python def visit_Ellipsis(_node: ast.ASTEllipsis) -> None: @@ -273,7 +273,7 @@ Parse info from `ast.Ellipsis` node and put it to `parts`. ### ExpressionAnalyzer().visit_FormattedValue -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L612) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L612) ```python def visit_FormattedValue(node: ast.FormattedValue) -> None: @@ -293,7 +293,7 @@ f"{formatted_value}" ### ExpressionAnalyzer().visit_GeneratorExp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L702) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L702) ```python def visit_GeneratorExp(node: ast.GeneratorExp) -> None: @@ -313,7 +313,7 @@ Parse info from `ast.GeneratorExp` node and put it to `parts`. ### ExpressionAnalyzer().visit_IfExp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L720) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L720) ```python def visit_IfExp(node: ast.IfExp) -> None: @@ -333,7 +333,7 @@ Parse info from `ast.IfExp` node and put it to `parts`. ### ExpressionAnalyzer().visit_Index -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L536) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L536) ```python def visit_Index(node: ast.Index) -> None: @@ -354,7 +354,7 @@ Union[str] ### ExpressionAnalyzer().visit_JoinedStr -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L590) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L590) ```python def visit_JoinedStr(node: ast.JoinedStr) -> None: @@ -374,7 +374,7 @@ f'str: {my_string}' ### ExpressionAnalyzer().visit_Lambda -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L454) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L454) ```python def visit_Lambda(node: ast.Lambda) -> None: @@ -394,7 +394,7 @@ lambda x: x + 5 ### ExpressionAnalyzer().visit_List -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L208) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L208) ```python def visit_List(node: ast.List) -> None: @@ -414,7 +414,7 @@ Parse info from `ast.List` node and put it to `parts`. ### ExpressionAnalyzer().visit_ListComp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L666) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L666) ```python def visit_ListComp(node: ast.ListComp) -> None: @@ -434,7 +434,7 @@ Parse info from `ast.ListComp` node and put it to `parts`. ### ExpressionAnalyzer().visit_Name -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L114) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L114) ```python def visit_Name(node: ast.Name) -> None: @@ -454,7 +454,7 @@ my_value ### ExpressionAnalyzer().visit_NameConstant -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L128) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L128) ```python def visit_NameConstant(node: ast.NameConstant) -> None: @@ -475,7 +475,7 @@ True ### ExpressionAnalyzer().visit_Num -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L99) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L99) ```python def visit_Num(node: ast.Num) -> None: @@ -496,7 +496,7 @@ Parse info from `ast.Num` node and put it to `parts`. ### ExpressionAnalyzer().visit_Set -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L223) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L223) ```python def visit_Set(node: ast.Set) -> None: @@ -516,7 +516,7 @@ Parse info from `ast.Set` node and put it to `parts`. ### ExpressionAnalyzer().visit_SetComp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L684) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L684) ```python def visit_SetComp(node: ast.SetComp) -> None: @@ -536,7 +536,7 @@ Parse info from `ast.SetComp` node and put it to `parts`. ### ExpressionAnalyzer().visit_Slice -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L566) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L566) ```python def visit_Slice(node: ast.Slice) -> None: @@ -560,7 +560,7 @@ Parse info from `ast.Slice` node and put it to `parts`. ### ExpressionAnalyzer().visit_Starred -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L307) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L307) ```python def visit_Starred(node: ast.Starred) -> None: @@ -580,7 +580,7 @@ Parse info from `ast.Starred` node and put it to `parts`. ### ExpressionAnalyzer().visit_Str -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L69) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L69) ```python def visit_Str(node: ast.Str) -> None: @@ -600,7 +600,7 @@ Parse info from `ast.Str` node and put it to `parts`. ### ExpressionAnalyzer().visit_Subscript -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L142) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L142) ```python def visit_Subscript(node: ast.Subscript) -> None: @@ -623,7 +623,7 @@ list[1:4] ### ExpressionAnalyzer().visit_Tuple -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L238) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L238) ```python def visit_Tuple(node: ast.Tuple) -> None: @@ -643,7 +643,7 @@ Parse info from `ast.Tuple` node and put it to `parts`. ### ExpressionAnalyzer().visit_UnaryOp -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L432) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L432) ```python def visit_UnaryOp(node: ast.UnaryOp) -> None: @@ -666,7 +666,7 @@ not True ### ExpressionAnalyzer().visit_Yield -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L751) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L751) ```python def visit_Yield(node: ast.Yield) -> None: @@ -687,7 +687,7 @@ yield value ### ExpressionAnalyzer().visit_YieldFrom -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L768) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L768) ```python def visit_YieldFrom(node: ast.YieldFrom) -> None: @@ -707,7 +707,7 @@ yield from my_generator ### ExpressionAnalyzer().visit_arg -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L519) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L519) ```python def visit_arg(node: ast.arg) -> None: @@ -728,7 +728,7 @@ def my_func(arg: str) ### ExpressionAnalyzer().visit_arguments -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L470) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L470) ```python def visit_arguments(node: ast.arguments) -> None: @@ -748,7 +748,7 @@ def my_func(arg, *args, **kwargs) ### ExpressionAnalyzer().visit_comprehension -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L627) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L627) ```python def visit_comprehension(node: ast.comprehension) -> None: @@ -768,7 +768,7 @@ for k in range(3) if k > 0 if True ### ExpressionAnalyzer().visit_keyword -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/expression_analyzer.py#L321) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/expression_analyzer.py#L321) ```python def visit_keyword(node: ast.keyword) -> None: diff --git a/docs/handsdown/ast_parser/analyzers/function_analyzer.md b/docs/handsdown/ast_parser/analyzers/function_analyzer.md index 2ba9b801..8bb15a2e 100644 --- a/docs/handsdown/ast_parser/analyzers/function_analyzer.md +++ b/docs/handsdown/ast_parser/analyzers/function_analyzer.md @@ -1,6 +1,6 @@ # FunctionAnalyzer -> Auto-generated documentation for [handsdown.ast_parser.analyzers.function_analyzer](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/function_analyzer.py) module. +> Auto-generated documentation for [handsdown.ast_parser.analyzers.function_analyzer](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/function_analyzer.py) module. AST analyzer for `ast.FunctionDef` records. @@ -13,7 +13,7 @@ AST analyzer for `ast.FunctionDef` records. ## FunctionAnalyzer -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/function_analyzer.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/function_analyzer.py#L12) ```python class FunctionAnalyzer(BaseAnalyzer): @@ -28,7 +28,7 @@ AST analyzer for `ast.FunctionDef` records. ### FunctionAnalyzer().generic_visit -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/function_analyzer.py#L161) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/function_analyzer.py#L161) ```python def generic_visit(node: ast.AST) -> None: @@ -42,7 +42,7 @@ Do nothing for unknown `ast.AST` nodes. ### FunctionAnalyzer().visit_AsyncFunctionDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/function_analyzer.py#L142) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/function_analyzer.py#L142) ```python def visit_AsyncFunctionDef(node: ast.AsyncFunctionDef) -> None: @@ -68,7 +68,7 @@ async def my_func(): ### FunctionAnalyzer().visit_FunctionDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/function_analyzer.py#L123) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/function_analyzer.py#L123) ```python def visit_FunctionDef(node: ast.FunctionDef) -> None: @@ -94,7 +94,7 @@ def my_func(): ### FunctionAnalyzer().visit_arguments -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/function_analyzer.py#L38) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/function_analyzer.py#L38) ```python def visit_arguments(node: ast.arguments) -> None: diff --git a/docs/handsdown/ast_parser/analyzers/index.md b/docs/handsdown/ast_parser/analyzers/index.md index 3e0c3322..f8548ca0 100644 --- a/docs/handsdown/ast_parser/analyzers/index.md +++ b/docs/handsdown/ast_parser/analyzers/index.md @@ -1,6 +1,6 @@ # Analyzers -> Auto-generated documentation for [handsdown.ast_parser.analyzers](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/__init__.py) module. +> Auto-generated documentation for [handsdown.ast_parser.analyzers](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/__init__.py) module. AST Analyzers. diff --git a/docs/handsdown/ast_parser/analyzers/module_analyzer.md b/docs/handsdown/ast_parser/analyzers/module_analyzer.md index a344cf45..7ff29907 100644 --- a/docs/handsdown/ast_parser/analyzers/module_analyzer.md +++ b/docs/handsdown/ast_parser/analyzers/module_analyzer.md @@ -1,6 +1,6 @@ # ModuleAnalyzer -> Auto-generated documentation for [handsdown.ast_parser.analyzers.module_analyzer](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py) module. +> Auto-generated documentation for [handsdown.ast_parser.analyzers.module_analyzer](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py) module. AST analyzer for `ast.Module` records. @@ -15,7 +15,7 @@ AST analyzer for `ast.Module` records. ## ModuleAnalyzer -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L11) ```python class ModuleAnalyzer(BaseAnalyzer): @@ -30,7 +30,7 @@ AST analyzer for `ast.Module` records. ### ModuleAnalyzer().visit_Assign -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L127) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L127) ```python def visit_Assign(node: ast.Assign) -> None: @@ -64,7 +64,7 @@ __all__ = all_list ### ModuleAnalyzer().visit_AsyncFunctionDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L109) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L109) ```python def visit_AsyncFunctionDef(node: ast.AsyncFunctionDef) -> None: @@ -88,7 +88,7 @@ async def my_func(arg1): ### ModuleAnalyzer().visit_ClassDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L58) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L58) ```python def visit_ClassDef(node: ast.ClassDef) -> None: @@ -112,7 +112,7 @@ class MyClass(): ### ModuleAnalyzer().visit_FunctionDef -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L91) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L91) ```python def visit_FunctionDef(node: ast.FunctionDef) -> None: @@ -136,7 +136,7 @@ def my_func(arg1): ### ModuleAnalyzer().visit_Import -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L24) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L24) ```python def visit_Import(node: ast.Import) -> None: @@ -161,7 +161,7 @@ import my_module.my_class as my_class ### ModuleAnalyzer().visit_ImportFrom -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/analyzers/module_analyzer.py#L42) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/analyzers/module_analyzer.py#L42) ```python def visit_ImportFrom(node: ast.ImportFrom) -> None: diff --git a/docs/handsdown/ast_parser/enums.md b/docs/handsdown/ast_parser/enums.md index e95aa400..9c304d76 100644 --- a/docs/handsdown/ast_parser/enums.md +++ b/docs/handsdown/ast_parser/enums.md @@ -1,6 +1,6 @@ # Enums -> Auto-generated documentation for [handsdown.ast_parser.enums](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/enums.py) module. +> Auto-generated documentation for [handsdown.ast_parser.enums](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/enums.py) module. Enums for AST parsing. @@ -10,7 +10,7 @@ Enums for AST parsing. ## RenderPart -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/enums.py#L7) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/enums.py#L7) ```python class RenderPart(enum.Enum): @@ -33,7 +33,7 @@ For [render](node_records/node_record.md#render) function. ### RenderPart().is_line_break -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/enums.py#L38) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/enums.py#L38) ```python def is_line_break() -> bool: diff --git a/docs/handsdown/ast_parser/index.md b/docs/handsdown/ast_parser/index.md index 101e56c7..c0ec15a3 100644 --- a/docs/handsdown/ast_parser/index.md +++ b/docs/handsdown/ast_parser/index.md @@ -1,6 +1,6 @@ # AST Parser. -> Auto-generated documentation for [handsdown.ast_parser](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/__init__.py) module. +> Auto-generated documentation for [handsdown.ast_parser](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/__init__.py) module. Collection of tools for analyzing AST and also rendering it back to a valid Python code. diff --git a/docs/handsdown/ast_parser/module_record_list.md b/docs/handsdown/ast_parser/module_record_list.md index def8ff33..5c932947 100644 --- a/docs/handsdown/ast_parser/module_record_list.md +++ b/docs/handsdown/ast_parser/module_record_list.md @@ -1,6 +1,6 @@ # ModuleRecordList -> Auto-generated documentation for [handsdown.ast_parser.module_record_list](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/module_record_list.py) module. +> Auto-generated documentation for [handsdown.ast_parser.module_record_list](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/module_record_list.py) module. Aggregation of `ModuleRecord` objects. @@ -13,7 +13,7 @@ Aggregation of `ModuleRecord` objects. ## ModuleRecordList -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/module_record_list.py#L11) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/module_record_list.py#L11) ```python class ModuleRecordList(): @@ -24,7 +24,7 @@ Aggregation of `ModuleRecord` objects. ### ModuleRecordList().\_\_iter\_\_ -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/module_record_list.py#L62) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/module_record_list.py#L62) ```python def __iter__() -> Iterator[ModuleRecord]: @@ -38,7 +38,7 @@ Iterate over all added `ModuleRecord` entries. ### ModuleRecordList().add -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/module_record_list.py#L52) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/module_record_list.py#L52) ```python def add(module_record: ModuleRecord) -> None: @@ -56,7 +56,7 @@ Add new `ModuleRecord`. ### ModuleRecordList().find_module_record -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/module_record_list.py#L21) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/module_record_list.py#L21) ```python def find_module_record(import_string: ImportString) -> Optional[ModuleRecord]: @@ -78,7 +78,7 @@ Found `NodeRecord` instance or None. ### ModuleRecordList().get_package_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/module_record_list.py#L43) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/module_record_list.py#L43) ```python def get_package_names() -> Set[str]: diff --git a/docs/handsdown/ast_parser/node_records/argument_record.md b/docs/handsdown/ast_parser/node_records/argument_record.md index dd0948aa..38c458e8 100644 --- a/docs/handsdown/ast_parser/node_records/argument_record.md +++ b/docs/handsdown/ast_parser/node_records/argument_record.md @@ -1,6 +1,6 @@ # ArgumentRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.argument_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/argument_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.argument_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/argument_record.py) module. Wrapper for an `ast.arg` node. @@ -12,7 +12,7 @@ Wrapper for an `ast.arg` node. ## ArgumentRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/argument_record.py#L13) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/argument_record.py#L13) ```python class ArgumentRecord(NodeRecord): @@ -39,7 +39,7 @@ Wrapper for an `ast.arg` node. ### ArgumentRecord().default -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/argument_record.py#L39) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/argument_record.py#L39) ```python @property @@ -54,7 +54,7 @@ Default exression or None. ### ArgumentRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/argument_record.py#L61) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/argument_record.py#L61) ```python @property @@ -65,7 +65,7 @@ Set of related names. ### ArgumentRecord().set_default -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/argument_record.py#L49) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/argument_record.py#L49) ```python def set_default(node: Node) -> None: diff --git a/docs/handsdown/ast_parser/node_records/attribute_record.md b/docs/handsdown/ast_parser/node_records/attribute_record.md index b9f2d786..92981701 100644 --- a/docs/handsdown/ast_parser/node_records/attribute_record.md +++ b/docs/handsdown/ast_parser/node_records/attribute_record.md @@ -1,6 +1,6 @@ # AttributeRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.attribute_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/attribute_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.attribute_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/attribute_record.py) module. Wrapper for an `ast.Assign` node of a module or class attribute. @@ -12,7 +12,7 @@ Wrapper for an `ast.Assign` node of a module or class attribute. ## AttributeRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/attribute_record.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/attribute_record.py#L12) ```python class AttributeRecord(NodeRecord): @@ -31,7 +31,7 @@ Wrapper for an `ast.Assign` node of a module or class attribute. ### AttributeRecord().append_to -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/attribute_record.py#L57) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/attribute_record.py#L57) ```python def append_to(node_record: NodeRecord) -> None: @@ -45,7 +45,7 @@ Append AttributeRecord to NodeRecord. ### AttributeRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/attribute_record.py#L29) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/attribute_record.py#L29) ```python @property @@ -56,7 +56,7 @@ Set of related names. ### AttributeRecord().render -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/attribute_record.py#L51) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/attribute_record.py#L51) ```python def render(indent: int = 0, allow_multiline: bool = False) -> str: diff --git a/docs/handsdown/ast_parser/node_records/class_record.md b/docs/handsdown/ast_parser/node_records/class_record.md index ea2adda1..b9b0a10b 100644 --- a/docs/handsdown/ast_parser/node_records/class_record.md +++ b/docs/handsdown/ast_parser/node_records/class_record.md @@ -1,6 +1,6 @@ # ClassRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.class_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/class_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.class_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/class_record.py) module. Wrapper for an `ast.ClassDef` node. @@ -13,7 +13,7 @@ Wrapper for an `ast.ClassDef` node. ## ClassRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/class_record.py#L17) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/class_record.py#L17) ```python class ClassRecord(NodeRecord): @@ -32,7 +32,7 @@ Wrapper for an `ast.ClassDef` node. ### ClassRecord().find_record -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/class_record.py#L36) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/class_record.py#L36) ```python def find_record(name: str) -> Optional[NodeRecord]: @@ -50,7 +50,7 @@ Itself or None. ### ClassRecord().get_public_methods -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/class_record.py#L89) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/class_record.py#L89) ```python def get_public_methods() -> List[FunctionRecord]: @@ -67,7 +67,7 @@ A list of child records. ### ClassRecord().iter_records -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/class_record.py#L76) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/class_record.py#L76) ```python def iter_records() -> Iterator[NodeRecord]: @@ -81,7 +81,7 @@ A child record. ### ClassRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/class_record.py#L59) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/class_record.py#L59) ```python @property diff --git a/docs/handsdown/ast_parser/node_records/expression_record.md b/docs/handsdown/ast_parser/node_records/expression_record.md index e1d18505..12f786ee 100644 --- a/docs/handsdown/ast_parser/node_records/expression_record.md +++ b/docs/handsdown/ast_parser/node_records/expression_record.md @@ -1,6 +1,6 @@ # ExpressionRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.expression_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/expression_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.expression_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/expression_record.py) module. Wrapper for an `ast.expr` node. @@ -10,7 +10,7 @@ Wrapper for an `ast.expr` node. ## ExpressionRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/expression_record.py#L13) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/expression_record.py#L13) ```python class ExpressionRecord(NodeRecord): @@ -29,7 +29,7 @@ Wrapper for an `ast.expr` node. ### ExpressionRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/expression_record.py#L28) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/expression_record.py#L28) ```python @property diff --git a/docs/handsdown/ast_parser/node_records/function_record.md b/docs/handsdown/ast_parser/node_records/function_record.md index b4391b0f..f1e3650c 100644 --- a/docs/handsdown/ast_parser/node_records/function_record.md +++ b/docs/handsdown/ast_parser/node_records/function_record.md @@ -1,6 +1,6 @@ # FunctionRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.function_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/function_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.function_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/function_record.py) module. Wrapper for an `ast.FunctionDef` node. @@ -11,7 +11,7 @@ Wrapper for an `ast.FunctionDef` node. ## FunctionRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/function_record.py#L17) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/function_record.py#L17) ```python class FunctionRecord(NodeRecord): @@ -31,7 +31,7 @@ Wrapper for an `ast.FunctionDef` and `ast.AsyncFunctionDef` node. ### FunctionRecord().parse_type_comments -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/function_record.py#L99) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/function_record.py#L99) ```python def parse_type_comments(lines: Iterable[str]) -> None: @@ -44,7 +44,7 @@ Also sets `return_type_hint` to a `TextRecord` if fucntion return type found. ### FunctionRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/function_record.py#L42) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/function_record.py#L42) ```python @property diff --git a/docs/handsdown/ast_parser/node_records/import_record.md b/docs/handsdown/ast_parser/node_records/import_record.md index 826c4eef..0956f358 100644 --- a/docs/handsdown/ast_parser/node_records/import_record.md +++ b/docs/handsdown/ast_parser/node_records/import_record.md @@ -1,6 +1,6 @@ # ImportRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.import_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/import_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.import_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/import_record.py) module. Wrapper for an `ast.Import` and `ast.ImportFrom` nodes. @@ -11,7 +11,7 @@ Wrapper for an `ast.Import` and `ast.ImportFrom` nodes. ## ImportRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/import_record.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/import_record.py#L12) ```python class ImportRecord(NodeRecord): @@ -32,7 +32,7 @@ Wrapper for an `ast.Import` and `ast.ImportFrom` nodes. ### ImportRecord().get_import_string -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/import_record.py#L32) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/import_record.py#L32) ```python def get_import_string() -> ImportString: @@ -50,7 +50,7 @@ An absolute import string. ### ImportRecord().match -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/import_record.py#L55) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/import_record.py#L55) ```python def match(name: str) -> Optional[ImportString]: diff --git a/docs/handsdown/ast_parser/node_records/index.md b/docs/handsdown/ast_parser/node_records/index.md index 7a712ba5..4a2e6880 100644 --- a/docs/handsdown/ast_parser/node_records/index.md +++ b/docs/handsdown/ast_parser/node_records/index.md @@ -1,6 +1,6 @@ # Node Records -> Auto-generated documentation for [handsdown.ast_parser.node_records](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/__init__.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/__init__.py) module. Wrappers for AST nodes. diff --git a/docs/handsdown/ast_parser/node_records/module_record.md b/docs/handsdown/ast_parser/node_records/module_record.md index 95ff7593..1c70b421 100644 --- a/docs/handsdown/ast_parser/node_records/module_record.md +++ b/docs/handsdown/ast_parser/node_records/module_record.md @@ -1,6 +1,6 @@ # ModuleRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.module_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.module_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py) module. Wrapper for an `ast.Module` node with corresponding node info. @@ -14,7 +14,7 @@ Wrapper for an `ast.Module` node with corresponding node info. ## ModuleRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py#L20) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py#L20) ```python class ModuleRecord(NodeRecord): @@ -35,7 +35,7 @@ Responsible for parsing Python source as well. ### ModuleRecord().build_children -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py#L151) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py#L151) ```python def build_children() -> None: @@ -47,7 +47,7 @@ Used only when doc for this ModuleRecord is building. ### ModuleRecord.create_from_source -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py#L44) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py#L44) ```python @classmethod @@ -77,7 +77,7 @@ New [ModuleRecord](#modulerecord) instance. ### ModuleRecord().find_record -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py#L72) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py#L72) ```python def find_record(import_string: ImportString) -> Optional[NodeRecord]: @@ -99,7 +99,7 @@ Found child record on None. ### ModuleRecord().get_related_import_strings -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py#L265) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py#L265) ```python def get_related_import_strings(node_record: NodeRecord) -> Set[ImportString]: @@ -117,7 +117,7 @@ A set of absolute import strings found. ### ModuleRecord().iter_records -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/module_record.py#L91) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/module_record.py#L91) ```python def iter_records() -> Iterator[NodeRecord]: diff --git a/docs/handsdown/ast_parser/node_records/node_record.md b/docs/handsdown/ast_parser/node_records/node_record.md index f32fc46c..e4bf7e55 100644 --- a/docs/handsdown/ast_parser/node_records/node_record.md +++ b/docs/handsdown/ast_parser/node_records/node_record.md @@ -1,6 +1,6 @@ # NodeRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.node_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.node_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py) module. Base class for all node records. @@ -17,7 +17,7 @@ Base class for all node records. ## NodeRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L13) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L13) ```python class NodeRecord(): @@ -36,7 +36,7 @@ Base class for all node records. ### NodeRecord().get_documented_attribute_strings -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L264) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L264) ```python def get_documented_attribute_strings() -> List[str]: @@ -52,7 +52,7 @@ A list of rendered strings. ### NodeRecord.is_line_fit -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L217) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L217) ```python @classmethod @@ -83,7 +83,7 @@ A string representation of indent. ### NodeRecord().line_number -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L47) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L47) ```python @property @@ -98,7 +98,7 @@ A line number startign with 1. ### NodeRecord().line_number -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L62) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L62) ```python @line_number.setter @@ -107,7 +107,7 @@ def line_number(value: int) -> None: ### NodeRecord().parse -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L89) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L89) ```python def parse() -> None: @@ -119,7 +119,7 @@ Executes only once if called multiple times. ### NodeRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L73) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L73) ```python @property @@ -136,7 +136,7 @@ A set of referenced object name. ### NodeRecord().render -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L157) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L157) ```python def render(indent: int = 0, allow_multiline: bool = False) -> str: @@ -158,7 +158,7 @@ A string representation of `node`. ### NodeRecord.render_indent -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/node_record.py#L241) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/node_record.py#L241) ```python @classmethod diff --git a/docs/handsdown/ast_parser/node_records/text_record.md b/docs/handsdown/ast_parser/node_records/text_record.md index b0468016..ba8a1147 100644 --- a/docs/handsdown/ast_parser/node_records/text_record.md +++ b/docs/handsdown/ast_parser/node_records/text_record.md @@ -1,6 +1,6 @@ # TextRecord -> Auto-generated documentation for [handsdown.ast_parser.node_records.text_record](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/text_record.py) module. +> Auto-generated documentation for [handsdown.ast_parser.node_records.text_record](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/text_record.py) module. Wrapper for a text-only `ast.expr` node. @@ -10,7 +10,7 @@ Wrapper for a text-only `ast.expr` node. ## TextRecord -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/text_record.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/text_record.py#L12) ```python class TextRecord(ExpressionRecord): @@ -30,7 +30,7 @@ Wrapper for a text-only `ast.expr` node. ### TextRecord().related_names -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/node_records/text_record.py#L28) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/node_records/text_record.py#L28) ```python @property diff --git a/docs/handsdown/ast_parser/smart_ast.md b/docs/handsdown/ast_parser/smart_ast.md index 12c69ba9..d2377aff 100644 --- a/docs/handsdown/ast_parser/smart_ast.md +++ b/docs/handsdown/ast_parser/smart_ast.md @@ -1,6 +1,6 @@ # Smart Ast -> Auto-generated documentation for [handsdown.ast_parser.smart_ast](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/smart_ast.py) module. +> Auto-generated documentation for [handsdown.ast_parser.smart_ast](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/smart_ast.py) module. Smart AST. diff --git a/docs/handsdown/ast_parser/type_defs.md b/docs/handsdown/ast_parser/type_defs.md index 78882842..20f23c44 100644 --- a/docs/handsdown/ast_parser/type_defs.md +++ b/docs/handsdown/ast_parser/type_defs.md @@ -1,6 +1,6 @@ # Type Defs -> Auto-generated documentation for [handsdown.ast_parser.type_defs](https://github.com/vemel/handsdown/blob/master/handsdown/ast_parser/type_defs.py) module. +> Auto-generated documentation for [handsdown.ast_parser.type_defs](https://github.com/vemel/handsdown/blob/main/handsdown/ast_parser/type_defs.py) module. Different AST-related types collection. diff --git a/docs/handsdown/cli_parser.md b/docs/handsdown/cli_parser.md index ed5ec219..b80029d3 100644 --- a/docs/handsdown/cli_parser.md +++ b/docs/handsdown/cli_parser.md @@ -1,6 +1,6 @@ # Cli Parser -> Auto-generated documentation for [handsdown.cli_parser](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py) module. +> Auto-generated documentation for [handsdown.cli_parser](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py) module. CLI Parser. @@ -15,7 +15,7 @@ CLI Parser. ## CLINamespace -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L16) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L16) ```python class CLINamespace(): @@ -41,7 +41,7 @@ Main CLI Namespace. ### CLINamespace().get_source_code_url -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L53) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L53) ```python def get_source_code_url() -> str: @@ -55,7 +55,7 @@ URL as a string. ## abs_path -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L97) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L97) ```python def abs_path(path_str: str) -> Path: @@ -73,7 +73,7 @@ An absolute path. ## dir_abs_path -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L110) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L110) ```python def dir_abs_path(path_str: str) -> Path: @@ -95,7 +95,7 @@ An absolute path. ## existing_dir_abs_path -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L129) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L129) ```python def existing_dir_abs_path(path_str: str) -> Path: @@ -117,7 +117,7 @@ An absolute path. ## git_repo -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L69) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L69) ```python def git_repo(git_repo_url: str) -> str: @@ -135,7 +135,7 @@ A GitHub URL. ## parse_args -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/cli_parser.py#L150) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/cli_parser.py#L150) ```python def parse_args(args: Iterable[str]) -> CLINamespace: diff --git a/docs/handsdown/generator.md b/docs/handsdown/generator.md index a218e735..0a6ccd3b 100644 --- a/docs/handsdown/generator.md +++ b/docs/handsdown/generator.md @@ -1,6 +1,6 @@ # Generator -> Auto-generated documentation for [handsdown.generator](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py) module. +> Auto-generated documentation for [handsdown.generator](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py) module. Main handsdown documentation generator. @@ -15,7 +15,7 @@ Main handsdown documentation generator. ## Generator -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L29) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L29) ```python class Generator(): @@ -63,7 +63,7 @@ Main documentation generator. ### Generator().cleanup_old_docs -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L149) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L149) ```python def cleanup_old_docs() -> None: @@ -73,7 +73,7 @@ Remove old docs generated for this module. ### Generator().generate_doc -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L185) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L185) ```python def generate_doc(source_path: Path) -> None: @@ -91,7 +91,7 @@ Generate one module doc at once. ### Generator().generate_docs -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L310) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L310) ```python def generate_docs() -> None: @@ -101,7 +101,7 @@ Generate all doc files at once. ### Generator().generate_index -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L323) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L323) ```python def generate_index() -> None: @@ -113,7 +113,7 @@ Also `Modules` section that contains a Tree of all modules in the project. ### Generator().generate_modules -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L349) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L349) ```python def generate_modules() -> None: @@ -126,7 +126,7 @@ section that contains a Tree of all modules in the project. ## GeneratorError -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/generator.py#L23) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/generator.py#L23) ```python class GeneratorError(Exception): diff --git a/docs/handsdown/index.md b/docs/handsdown/index.md index 8db412fc..02d11aa1 100644 --- a/docs/handsdown/index.md +++ b/docs/handsdown/index.md @@ -1,6 +1,6 @@ # Handsdown -> Auto-generated documentation for [handsdown](https://github.com/vemel/handsdown/blob/master/handsdown/__init__.py) module. +> Auto-generated documentation for [handsdown](https://github.com/vemel/handsdown/blob/main/handsdown/__init__.py) module. Root of [Handsdown](#handsdown) source code. @@ -241,10 +241,10 @@ pip install handsdown ## More examples - All documentation in this project -- [Main](https://github.com/vemel/handsdown/blob/master/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/main_example.md) -- [RST docstrings](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/rst_docstrings.md) -- [Google docstrings](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/google_docstrings.md) -- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/pep257_docstrings.md) -- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/sphinx_docstrings.md) -- [Type annotations](https://github.com/vemel/handsdown/blob/master/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/typed.md) -- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/comment_typed.md) +- [Main](https://github.com/vemel/handsdown/blob/main/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/main_example.md) +- [RST docstrings](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/rst_docstrings.md) +- [Google docstrings](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/google_docstrings.md) +- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/pep257_docstrings.md) +- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/sphinx_docstrings.md) +- [Type annotations](https://github.com/vemel/handsdown/blob/main/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/typed.md) +- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/comment_typed.md) diff --git a/docs/handsdown/loader.md b/docs/handsdown/loader.md index ab677cf1..14f8a523 100644 --- a/docs/handsdown/loader.md +++ b/docs/handsdown/loader.md @@ -1,6 +1,6 @@ # Loader -> Auto-generated documentation for [handsdown.loader](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py) module. +> Auto-generated documentation for [handsdown.loader](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py) module. Loader for python source code. @@ -14,7 +14,7 @@ Loader for python source code. ## Loader -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py#L22) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py#L22) ```python class Loader(): @@ -46,7 +46,7 @@ my_module_utils = loader.import_module('my_module.utils') ### Loader().get_import_string -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py#L129) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py#L129) ```python def get_import_string(source_path: Path) -> str: @@ -75,7 +75,7 @@ A Python import string. ### Loader().get_module_record -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py#L64) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py#L64) ```python def get_module_record(source_path: Path) -> Optional[ModuleRecord]: @@ -97,7 +97,7 @@ A new `ModuleRecord` instance or None if there is ntohing to import. ### Loader().get_output_path -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py#L44) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py#L44) ```python def get_output_path(source_path: Path) -> Path: @@ -115,7 +115,7 @@ A path to the output `.md` file even if it does not exist yet. ### Loader.parse_module_record -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py#L114) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py#L114) ```python @staticmethod @@ -134,7 +134,7 @@ Parse `ModuleRecord` children and fully load a tree for it. ## LoaderError -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/loader.py#L16) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/loader.py#L16) ```python class LoaderError(Exception): diff --git a/docs/handsdown/main.md b/docs/handsdown/main.md index 0a853363..c8e44331 100644 --- a/docs/handsdown/main.md +++ b/docs/handsdown/main.md @@ -1,6 +1,6 @@ # Main -> Auto-generated documentation for [handsdown.main](https://github.com/vemel/handsdown/blob/master/handsdown/main.py) module. +> Auto-generated documentation for [handsdown.main](https://github.com/vemel/handsdown/blob/main/handsdown/main.py) module. Main CLI entrypoint for [Handsdown](index.md#handsdown). @@ -10,7 +10,7 @@ Main CLI entrypoint for [Handsdown](index.md#handsdown). ## create_external_configs -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/main.py#L14) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/main.py#L14) ```python def create_external_configs(namespace: CLINamespace) -> None: @@ -24,7 +24,7 @@ Create `GitHub Pages` and `Read the Docs` configuration files. ## main -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/main.py#L42) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/main.py#L42) ```python def main() -> None: diff --git a/docs/handsdown/md_document.md b/docs/handsdown/md_document.md index 9769fd17..0cce110b 100644 --- a/docs/handsdown/md_document.md +++ b/docs/handsdown/md_document.md @@ -1,6 +1,6 @@ # MDDocument -> Auto-generated documentation for [handsdown.md_document](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py) module. +> Auto-generated documentation for [handsdown.md_document](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py) module. Markdown file builder. @@ -29,7 +29,7 @@ Markdown file builder. ## MDDocument -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L21) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L21) ```python class MDDocument(): @@ -82,7 +82,7 @@ with MDDocument(path=Path('output.md')) as md_document: ### MDDocument().add_toc_if_not_exists -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L123) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L123) ```python def add_toc_if_not_exists() -> None: @@ -92,7 +92,7 @@ Check if ToC exists in the document or create one. ### MDDocument().append -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L312) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L312) ```python def append(content: str) -> None: @@ -109,7 +109,7 @@ Handle trimming and sectioning the content and update ### MDDocument().append_title -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L333) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L333) ```python def append_title(title: str, level: int) -> None: @@ -127,7 +127,7 @@ Handle trimming and sectioning the content and update ### MDDocument().generate_toc_section -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L349) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L349) ```python def generate_toc_section(max_depth: int = 3) -> str: @@ -145,7 +145,7 @@ A string with ToC. ### MDDocument.get_anchor -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L130) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L130) ```python @classmethod @@ -160,7 +160,7 @@ A test of anchor link. ### MDDocument.get_toc_line -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L396) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L396) ```python @classmethod @@ -180,7 +180,7 @@ Ready to insert ToC line. ### MDDocument.is_toc -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L142) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L142) ```python @staticmethod @@ -195,7 +195,7 @@ True the section is ToC. ### MDDocument().path -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L305) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L305) ```python @property @@ -206,7 +206,7 @@ Output path of the document. ### MDDocument().read -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L88) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L88) ```python def read(source_path: Optional[Path] = None) -> None: @@ -221,7 +221,7 @@ Read and parse content from `source_path`. ### MDDocument().render_doc_link -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L200) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L200) ```python def render_doc_link( @@ -266,7 +266,7 @@ A string with Markdown link. ### MDDocument.render_link -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L159) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L159) ```python @classmethod @@ -296,7 +296,7 @@ A string with Markdown link. ### MDDocument().render_md_doc_link -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L181) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L181) ```python def render_md_doc_link( @@ -318,7 +318,7 @@ A string with Markdown link. ### MDDocument().sections -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L298) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L298) ```python @property @@ -329,7 +329,7 @@ All non-special `sections` of the document. ### MDDocument().subtitle -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L274) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L274) ```python @property @@ -340,7 +340,7 @@ def subtitle() -> str: ### MDDocument().subtitle -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L281) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L281) ```python @subtitle.setter @@ -349,7 +349,7 @@ def subtitle(subtitle: str) -> None: ### MDDocument().title -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L262) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L262) ```python @property @@ -360,7 +360,7 @@ def title() -> str: ### MDDocument().title -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L269) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L269) ```python @title.setter @@ -369,7 +369,7 @@ def title(title: str) -> None: ### MDDocument().toc_section -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L286) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L286) ```python @property @@ -380,7 +380,7 @@ Document Tree of Contents section or an empty line. ### MDDocument().toc_section -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L293) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L293) ```python @toc_section.setter @@ -389,7 +389,7 @@ def toc_section(toc_section: str) -> None: ### MDDocument().write -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/md_document.py#L254) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/md_document.py#L254) ```python def write() -> None: diff --git a/docs/handsdown/module.md b/docs/handsdown/module.md index 39aa4de3..d5342076 100644 --- a/docs/handsdown/module.md +++ b/docs/handsdown/module.md @@ -1,6 +1,6 @@ # Module -> Auto-generated documentation for [handsdown.__main__](https://github.com/vemel/handsdown/blob/master/handsdown/__main__.py) module. +> Auto-generated documentation for [handsdown.__main__](https://github.com/vemel/handsdown/blob/main/handsdown/__main__.py) module. Main module entrypoint. diff --git a/docs/handsdown/processors/base.md b/docs/handsdown/processors/base.md index b1bacecc..8cae8c0f 100644 --- a/docs/handsdown/processors/base.md +++ b/docs/handsdown/processors/base.md @@ -1,6 +1,6 @@ # Base Docstring Processor. -> Auto-generated documentation for [handsdown.processors.base](https://github.com/vemel/handsdown/blob/master/handsdown/processors/base.py) module. +> Auto-generated documentation for [handsdown.processors.base](https://github.com/vemel/handsdown/blob/main/handsdown/processors/base.py) module. Base class for all docstring processors: @@ -27,7 +27,7 @@ Base class for all docstring processors: ## BaseDocstringProcessor -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/base.py#L28) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/base.py#L28) ```python class BaseDocstringProcessor(): @@ -44,7 +44,7 @@ Base docstring processor. All docstring processors are based on top of it. ### BaseDocstringProcessor().build_sections -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/base.py#L66) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/base.py#L66) ```python def build_sections(content: str) -> SectionMap: diff --git a/docs/handsdown/processors/index.md b/docs/handsdown/processors/index.md index 4f1bf85e..c36cd194 100644 --- a/docs/handsdown/processors/index.md +++ b/docs/handsdown/processors/index.md @@ -1,6 +1,6 @@ # Processors -> Auto-generated documentation for [handsdown.processors](https://github.com/vemel/handsdown/blob/master/handsdown/processors/__init__.py) module. +> Auto-generated documentation for [handsdown.processors](https://github.com/vemel/handsdown/blob/main/handsdown/processors/__init__.py) module. Docstrings processors. diff --git a/docs/handsdown/processors/pep257.md b/docs/handsdown/processors/pep257.md index 46c2321b..60dbdb23 100644 --- a/docs/handsdown/processors/pep257.md +++ b/docs/handsdown/processors/pep257.md @@ -1,6 +1,6 @@ # PEP 257 Docstring Processor. -> Auto-generated documentation for [handsdown.processors.pep257](https://github.com/vemel/handsdown/blob/master/handsdown/processors/pep257.py) module. +> Auto-generated documentation for [handsdown.processors.pep257](https://github.com/vemel/handsdown/blob/main/handsdown/processors/pep257.py) module. Docstring processor for PEP 257 and Google docstring format. @@ -32,7 +32,7 @@ Docstring processor for PEP 257 and Google docstring format. ## PEP257DocstringProcessor -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/pep257.py#L33) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/pep257.py#L33) ```python class PEP257DocstringProcessor(BaseDocstringProcessor): diff --git a/docs/handsdown/processors/rst.md b/docs/handsdown/processors/rst.md index 4a9bdfa6..788d671b 100644 --- a/docs/handsdown/processors/rst.md +++ b/docs/handsdown/processors/rst.md @@ -1,6 +1,6 @@ # reStructuredText Docstring Processor. -> Auto-generated documentation for [handsdown.processors.rst](https://github.com/vemel/handsdown/blob/master/handsdown/processors/rst.py) module. +> Auto-generated documentation for [handsdown.processors.rst](https://github.com/vemel/handsdown/blob/main/handsdown/processors/rst.py) module. Docstring processor for restructured text docstring format. @@ -30,7 +30,7 @@ Supported features: ## RSTDocstringProcessor -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/rst.py#L33) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/rst.py#L33) ```python class RSTDocstringProcessor(BaseDocstringProcessor): diff --git a/docs/handsdown/processors/section_map.md b/docs/handsdown/processors/section_map.md index fd0d9c5d..c0115f67 100644 --- a/docs/handsdown/processors/section_map.md +++ b/docs/handsdown/processors/section_map.md @@ -1,6 +1,6 @@ # SectionMap -> Auto-generated documentation for [handsdown.processors.section_map](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py) module. +> Auto-generated documentation for [handsdown.processors.section_map](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py) module. Module for splitting docstring into `Section` groups. @@ -18,7 +18,7 @@ Module for splitting docstring into `Section` groups. ## Section -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L31) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L31) ```python class Section(): @@ -34,7 +34,7 @@ Dataclass representing a section in a [SectionMap](#sectionmap). ### Section().render -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L44) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L44) ```python def render() -> str: @@ -48,7 +48,7 @@ Section lines as a text. ## SectionBlock -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L9) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L9) ```python class SectionBlock(): @@ -63,7 +63,7 @@ Dataclass representing a [Section](#section) block. ### SectionBlock().render -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L20) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L20) ```python def render() -> str: @@ -77,7 +77,7 @@ Block lines as a text. ## SectionMap -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L58) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L58) ```python class SectionMap(dict): @@ -93,7 +93,7 @@ Value is a related [Section](#section) instance. ### SectionMap().add_block -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L111) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L111) ```python def add_block(section_name: str) -> None: @@ -109,7 +109,7 @@ If [Section](#section) does not exist - it is not created. ### SectionMap().add_line -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L88) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L88) ```python def add_line(section_name: str, line: str) -> None: @@ -126,7 +126,7 @@ If line and section are empty - section is not created. ### SectionMap().add_line_indent -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L72) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L72) ```python def add_line_indent(section_name: str, line: str) -> None: @@ -141,7 +141,7 @@ Add line respecting indent of the current section block. ### SectionMap().sections -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L141) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L141) ```python @property @@ -156,7 +156,7 @@ Iterate over existing [Section](#section) objects. ### SectionMap().trim_block -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/section_map.py#L125) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/section_map.py#L125) ```python def trim_block(section_name: str) -> None: diff --git a/docs/handsdown/processors/smart.md b/docs/handsdown/processors/smart.md index 12634890..8bead5c3 100644 --- a/docs/handsdown/processors/smart.md +++ b/docs/handsdown/processors/smart.md @@ -1,6 +1,6 @@ # Smart -> Auto-generated documentation for [handsdown.processors.smart](https://github.com/vemel/handsdown/blob/master/handsdown/processors/smart.py) module. +> Auto-generated documentation for [handsdown.processors.smart](https://github.com/vemel/handsdown/blob/main/handsdown/processors/smart.py) module. Smart Docstring Processor. @@ -15,7 +15,7 @@ Docstring processor that selects a `DocstringProcessor` based on a docstring con ## SmartDocstringProcessor -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/smart.py#L15) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/smart.py#L15) ```python class SmartDocstringProcessor(BaseDocstringProcessor): @@ -30,7 +30,7 @@ Docstring processor that selects a `DocstringProcessor` based on a docstring con ### SmartDocstringProcessor().build_sections -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/processors/smart.py#L28) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/processors/smart.py#L28) ```python def build_sections(content: str) -> SectionMap: diff --git a/docs/handsdown/settings.md b/docs/handsdown/settings.md index e51adcae..93b8013b 100644 --- a/docs/handsdown/settings.md +++ b/docs/handsdown/settings.md @@ -1,6 +1,6 @@ # Settings -> Auto-generated documentation for [handsdown.settings](https://github.com/vemel/handsdown/blob/master/handsdown/settings.py) module. +> Auto-generated documentation for [handsdown.settings](https://github.com/vemel/handsdown/blob/main/handsdown/settings.py) module. Various project constants. diff --git a/docs/handsdown/utils/docstring_formatter.md b/docs/handsdown/utils/docstring_formatter.md index ae39a716..faf9c6a6 100644 --- a/docs/handsdown/utils/docstring_formatter.md +++ b/docs/handsdown/utils/docstring_formatter.md @@ -1,6 +1,6 @@ # DocstringFormatter -> Auto-generated documentation for [handsdown.utils.docstring_formatter](https://github.com/vemel/handsdown/blob/master/handsdown/utils/docstring_formatter.py) module. +> Auto-generated documentation for [handsdown.utils.docstring_formatter](https://github.com/vemel/handsdown/blob/main/handsdown/utils/docstring_formatter.py) module. Translator of docstrings to Markdown format. @@ -10,7 +10,7 @@ Translator of docstrings to Markdown format. ## DocstringFormatter -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/docstring_formatter.py#L9) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/docstring_formatter.py#L9) ```python class DocstringFormatter(): @@ -25,7 +25,7 @@ Translator of docstrings to Markdown format. ### DocstringFormatter().render -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/docstring_formatter.py#L57) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/docstring_formatter.py#L57) ```python def render() -> str: diff --git a/docs/handsdown/utils/import_string.md b/docs/handsdown/utils/import_string.md index dd81a3b7..86cfc04a 100644 --- a/docs/handsdown/utils/import_string.md +++ b/docs/handsdown/utils/import_string.md @@ -1,6 +1,6 @@ # ImportString -> Auto-generated documentation for [handsdown.utils.import_string](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py) module. +> Auto-generated documentation for [handsdown.utils.import_string](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py) module. Wrapper for python import strings. @@ -18,7 +18,7 @@ Wrapper for python import strings. ## ImportString -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L13) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L13) ```python class ImportString(): @@ -33,7 +33,7 @@ Wrapper for python import strings. ### ImportString().\_\_add\_\_ -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L41) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L41) ```python def __add__(other: str) -> 'ImportString': @@ -61,7 +61,7 @@ A new [ImportString](#importstring) instance. ### ImportString().\_\_bool\_\_ -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L64) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L64) ```python def __bool__() -> bool: @@ -85,7 +85,7 @@ True if not empty. ### ImportString().\_\_eq\_\_ -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L81) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L81) ```python def __eq__(other: Any) -> bool: @@ -122,7 +122,7 @@ True if import strings are equal. ### ImportString().\_\_str\_\_ -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L24) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L24) ```python def __str__() -> str: @@ -143,7 +143,7 @@ Original import string. ### ImportString().is_top_level -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L134) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L134) ```python def is_top_level() -> bool: @@ -157,7 +157,7 @@ True if it has no parents. ### ImportString().parent -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L143) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L143) ```python @property @@ -172,7 +172,7 @@ A new [ImportString](#importstring) instance. ### ImportString().parts -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L116) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L116) ```python @property @@ -197,7 +197,7 @@ A list of import string parts. ### ImportString().startswith -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L157) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L157) ```python def startswith(import_string: 'ImportString') -> bool: @@ -211,7 +211,7 @@ True if it is a child. ## ImportStringError -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/import_string.py#L7) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/import_string.py#L7) ```python class ImportStringError(Exception): diff --git a/docs/handsdown/utils/indent_trimmer.md b/docs/handsdown/utils/indent_trimmer.md index 63307b6b..cea454b5 100644 --- a/docs/handsdown/utils/indent_trimmer.md +++ b/docs/handsdown/utils/indent_trimmer.md @@ -1,6 +1,6 @@ # IndentTrimmer -> Auto-generated documentation for [handsdown.utils.indent_trimmer](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py) module. +> Auto-generated documentation for [handsdown.utils.indent_trimmer](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py) module. Utility for removing indentation for sections and lines. @@ -15,7 +15,7 @@ Utility for removing indentation for sections and lines. ## IndentTrimmer -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L10) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L10) ```python class IndentTrimmer(): @@ -25,7 +25,7 @@ Utility for removing indentation for sections and lines. ### IndentTrimmer.get_line_indent -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L119) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L119) ```python @staticmethod @@ -54,7 +54,7 @@ A number of indentation characters in a beginning of the line. ### IndentTrimmer.indent_line -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L140) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L140) ```python @staticmethod @@ -81,7 +81,7 @@ An indented line. ### IndentTrimmer.trim_empty_lines -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L15) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L15) ```python @staticmethod @@ -104,7 +104,7 @@ A stripped string. ### IndentTrimmer.trim_line -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L92) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L92) ```python @staticmethod @@ -136,7 +136,7 @@ A line with removed indent. ### IndentTrimmer.trim_lines -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L57) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L57) ```python @classmethod @@ -170,7 +170,7 @@ A list of lines with trimmed indent. ### IndentTrimmer.trim_text -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/indent_trimmer.py#L37) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/indent_trimmer.py#L37) ```python @classmethod diff --git a/docs/handsdown/utils/index.md b/docs/handsdown/utils/index.md index 40e5a840..48b441c4 100644 --- a/docs/handsdown/utils/index.md +++ b/docs/handsdown/utils/index.md @@ -1,6 +1,6 @@ # Utils -> Auto-generated documentation for [handsdown.utils](https://github.com/vemel/handsdown/blob/master/handsdown/utils/__init__.py) module. +> Auto-generated documentation for [handsdown.utils](https://github.com/vemel/handsdown/blob/main/handsdown/utils/__init__.py) module. Handful utils that do not deserve a separate module. @@ -17,7 +17,7 @@ Handful utils that do not deserve a separate module. ## extract_md_title -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/__init__.py#L68) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/__init__.py#L68) ```python def extract_md_title(content: str) -> Tuple[(str, str)]: @@ -44,7 +44,7 @@ A tuple fo title and remaining content. ## make_title -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/__init__.py#L12) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/__init__.py#L12) ```python def make_title(file_stem: str) -> str: @@ -80,7 +80,7 @@ A human-readable title as a string. ## render_asset -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/__init__.py#L53) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/__init__.py#L53) ```python def render_asset( diff --git a/docs/handsdown/utils/logger.md b/docs/handsdown/utils/logger.md index e3802967..87d30ac5 100644 --- a/docs/handsdown/utils/logger.md +++ b/docs/handsdown/utils/logger.md @@ -1,6 +1,6 @@ # Logger -> Auto-generated documentation for [handsdown.utils.logger](https://github.com/vemel/handsdown/blob/master/handsdown/utils/logger.py) module. +> Auto-generated documentation for [handsdown.utils.logger](https://github.com/vemel/handsdown/blob/main/handsdown/utils/logger.py) module. Utilities for stdout stream logger. @@ -9,7 +9,7 @@ Utilities for stdout stream logger. ## get_logger -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/logger.py#L10) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/logger.py#L10) ```python def get_logger(level: Optional[int] = None) -> logging.Logger: diff --git a/docs/handsdown/utils/path_finder.md b/docs/handsdown/utils/path_finder.md index 1d2da460..7b40d789 100644 --- a/docs/handsdown/utils/path_finder.md +++ b/docs/handsdown/utils/path_finder.md @@ -1,6 +1,6 @@ # PathFinder -> Auto-generated documentation for [handsdown.utils.path_finder](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py) module. +> Auto-generated documentation for [handsdown.utils.path_finder](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py) module. Glob helper for matching paths inside `root` path. @@ -17,7 +17,7 @@ Supports `.gitignore`-like `include` and `exclude` patterns. ## PathFinder -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L20) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L20) ```python class PathFinder(): @@ -53,7 +53,7 @@ list(path_finder.exclude('*new*').glob('*.txt')) ### PathFinder().exclude -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L87) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L87) ```python def exclude(*fn_exrps: str) -> 'PathFinder': @@ -74,7 +74,7 @@ A copy of itself. ### PathFinder().glob -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L130) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L130) ```python def glob(glob_expr: str) -> Iterator[Path]: @@ -88,7 +88,7 @@ Matching `Path` objects. ### PathFinder().include -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L66) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L66) ```python def include(*fn_exrps: str) -> 'PathFinder': @@ -109,7 +109,7 @@ A copy of itself. ### PathFinder().mkdir -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L175) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L175) ```python def mkdir(force: bool = False) -> None: @@ -127,7 +127,7 @@ Create directories up to `root` if they do not exist. ### PathFinder().relative -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L146) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L146) ```python def relative(target: Path) -> Path: @@ -147,7 +147,7 @@ A relative path to `target`. ## PathFinderError -[[find in source code]](https://github.com/vemel/handsdown/blob/master/handsdown/utils/path_finder.py#L14) +[[find in source code]](https://github.com/vemel/handsdown/blob/main/handsdown/utils/path_finder.py#L14) ```python class PathFinderError(Exception): diff --git a/handsdown/README.md b/handsdown/README.md index e94416a9..20a20c62 100644 --- a/handsdown/README.md +++ b/handsdown/README.md @@ -214,10 +214,10 @@ pip install handsdown ## More examples - All documentation in this project -- [Main](https://github.com/vemel/handsdown/blob/master/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/main_example.md) -- [RST docstrings](https://github.com/vemel/handsdown/blob/master/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/rst_docstrings.md) -- [Google docstrings](https://github.com/vemel/handsdown/blob/master/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/google_docstrings.md) -- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/master/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/pep257_docstrings.md) -- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/master/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/sphinx_docstrings.md) -- [Type annotations](https://github.com/vemel/handsdown/blob/master/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/typed.md) -- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/master/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/master/docs/examples/comment_typed.md) +- [Main](https://github.com/vemel/handsdown/blob/main/examples/main_example.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/main_example.md) +- [RST docstrings](https://github.com/vemel/handsdown/blob/main/examples/rst_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/rst_docstrings.md) +- [Google docstrings](https://github.com/vemel/handsdown/blob/main/examples/google_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/google_docstrings.md) +- [PEP 257 docstrings](https://github.com/vemel/handsdown/blob/main/examples/pep257_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/pep257_docstrings.md) +- [Sphinx docstrings](https://github.com/vemel/handsdown/blob/main/examples/sphinx_docstrings.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/sphinx_docstrings.md) +- [Type annotations](https://github.com/vemel/handsdown/blob/main/examples/typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/typed.md) +- [Comment-style type annotations](https://github.com/vemel/handsdown/blob/main/examples/comment_typed.py) with [generated output](https://github.com/vemel/handsdown/tree/main/docs/examples/comment_typed.md) diff --git a/scripts/update_docs.sh b/scripts/update_docs.sh index 793f400d..47236b56 100755 --- a/scripts/update_docs.sh +++ b/scripts/update_docs.sh @@ -4,5 +4,5 @@ set -e ROOT_PATH=$(dirname $(dirname $(realpath $0))) cd $ROOT_PATH -handsdown -o docs_local --cleanup --branch master $@ -handsdown --external `git config --get remote.origin.url` --cleanup --branch master $@ +handsdown -o docs_local --cleanup --branch main $@ +handsdown --external `git config --get remote.origin.url` --cleanup --branch main $@