├── .codecov.yml ├── .coveragerc ├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── art ├── logo.png ├── logo_large.png └── logo_large.xcf ├── docs ├── contributing │ ├── 1.-contributing-guide.md │ ├── 2.-coding-standard.md │ ├── 3.-code-of-conduct.md │ └── 4.-acknowledgements.md └── quick_start │ ├── 1.-installation.md │ ├── 2.-cli.md │ └── 3.-api.md ├── pdocs ├── __init__.py ├── _version.py ├── api.py ├── cli.py ├── defaults.py ├── doc.py ├── extract.py ├── html_helpers.py ├── logo.py ├── render.py ├── static.py └── templates │ ├── LICENSE │ ├── README.md │ ├── css.mako │ ├── html_frame.mako │ ├── html_index.mako │ ├── html_module.mako │ └── text.mako ├── pyproject.toml ├── scripts ├── clean.sh ├── lint.sh └── test.sh ├── tests ├── docstring_parser │ ├── example_google.py │ └── example_numpy.py ├── modules │ ├── README │ ├── dirmod │ │ └── __init__.py │ ├── index │ │ ├── __init__.py │ │ ├── index.py │ │ └── two │ │ │ └── __init__.py │ ├── malformed │ │ └── syntax.py │ ├── one.py │ └── submods │ │ ├── __init__.py │ │ ├── three │ │ └── __init__.py │ │ └── two.py ├── onpath │ ├── README │ ├── __init__.py │ ├── malformed_syntax.py │ └── simple.py ├── test_doc.py ├── test_extract.py ├── test_parse_docstring.py ├── test_pdoc.py ├── test_render.py ├── test_static.py └── tutils.py └── tox.ini /.codecov.yml: -------------------------------------------------------------------------------- 1 | comment: off 2 | -------------------------------------------------------------------------------- /.coveragerc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/.coveragerc -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/.gitignore -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/.travis.yml -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/CHANGELOG.md -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/README.md -------------------------------------------------------------------------------- /art/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/art/logo.png -------------------------------------------------------------------------------- /art/logo_large.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/art/logo_large.png -------------------------------------------------------------------------------- /art/logo_large.xcf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/art/logo_large.xcf -------------------------------------------------------------------------------- /docs/contributing/1.-contributing-guide.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/contributing/1.-contributing-guide.md -------------------------------------------------------------------------------- /docs/contributing/2.-coding-standard.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/contributing/2.-coding-standard.md -------------------------------------------------------------------------------- /docs/contributing/3.-code-of-conduct.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/contributing/3.-code-of-conduct.md -------------------------------------------------------------------------------- /docs/contributing/4.-acknowledgements.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/contributing/4.-acknowledgements.md -------------------------------------------------------------------------------- /docs/quick_start/1.-installation.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/quick_start/1.-installation.md -------------------------------------------------------------------------------- /docs/quick_start/2.-cli.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/quick_start/2.-cli.md -------------------------------------------------------------------------------- /docs/quick_start/3.-api.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/docs/quick_start/3.-api.md -------------------------------------------------------------------------------- /pdocs/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/__init__.py -------------------------------------------------------------------------------- /pdocs/_version.py: -------------------------------------------------------------------------------- 1 | __version__ = "1.2.0" 2 | -------------------------------------------------------------------------------- /pdocs/api.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/api.py -------------------------------------------------------------------------------- /pdocs/cli.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/cli.py -------------------------------------------------------------------------------- /pdocs/defaults.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/defaults.py -------------------------------------------------------------------------------- /pdocs/doc.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/doc.py -------------------------------------------------------------------------------- /pdocs/extract.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/extract.py -------------------------------------------------------------------------------- /pdocs/html_helpers.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/html_helpers.py -------------------------------------------------------------------------------- /pdocs/logo.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/logo.py -------------------------------------------------------------------------------- /pdocs/render.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/render.py -------------------------------------------------------------------------------- /pdocs/static.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/static.py -------------------------------------------------------------------------------- /pdocs/templates/LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/LICENSE -------------------------------------------------------------------------------- /pdocs/templates/README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/README.md -------------------------------------------------------------------------------- /pdocs/templates/css.mako: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/css.mako -------------------------------------------------------------------------------- /pdocs/templates/html_frame.mako: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/html_frame.mako -------------------------------------------------------------------------------- /pdocs/templates/html_index.mako: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/html_index.mako -------------------------------------------------------------------------------- /pdocs/templates/html_module.mako: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/html_module.mako -------------------------------------------------------------------------------- /pdocs/templates/text.mako: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pdocs/templates/text.mako -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/pyproject.toml -------------------------------------------------------------------------------- /scripts/clean.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/scripts/clean.sh -------------------------------------------------------------------------------- /scripts/lint.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/scripts/lint.sh -------------------------------------------------------------------------------- /scripts/test.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/scripts/test.sh -------------------------------------------------------------------------------- /tests/docstring_parser/example_google.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/docstring_parser/example_google.py -------------------------------------------------------------------------------- /tests/docstring_parser/example_numpy.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/docstring_parser/example_numpy.py -------------------------------------------------------------------------------- /tests/modules/README: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/modules/README -------------------------------------------------------------------------------- /tests/modules/dirmod/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/modules/dirmod/__init__.py -------------------------------------------------------------------------------- /tests/modules/index/__init__.py: -------------------------------------------------------------------------------- 1 | ROOT = 1 2 | -------------------------------------------------------------------------------- /tests/modules/index/index.py: -------------------------------------------------------------------------------- 1 | INDEX = 1 2 | -------------------------------------------------------------------------------- /tests/modules/index/two/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modules/malformed/syntax.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/modules/malformed/syntax.py -------------------------------------------------------------------------------- /tests/modules/one.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/modules/one.py -------------------------------------------------------------------------------- /tests/modules/submods/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/modules/submods/__init__.py -------------------------------------------------------------------------------- /tests/modules/submods/three/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/modules/submods/two.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/onpath/README: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/onpath/README -------------------------------------------------------------------------------- /tests/onpath/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/onpath/malformed_syntax.py: -------------------------------------------------------------------------------- 1 | 2 | # Syntax error 3 | class 4 | -------------------------------------------------------------------------------- /tests/onpath/simple.py: -------------------------------------------------------------------------------- 1 | def simple(): 2 | pass 3 | -------------------------------------------------------------------------------- /tests/test_doc.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/test_doc.py -------------------------------------------------------------------------------- /tests/test_extract.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/test_extract.py -------------------------------------------------------------------------------- /tests/test_parse_docstring.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/test_parse_docstring.py -------------------------------------------------------------------------------- /tests/test_pdoc.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/test_pdoc.py -------------------------------------------------------------------------------- /tests/test_render.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/test_render.py -------------------------------------------------------------------------------- /tests/test_static.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/test_static.py -------------------------------------------------------------------------------- /tests/tutils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tests/tutils.py -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timothycrosley/pdocs/HEAD/tox.ini --------------------------------------------------------------------------------