Django-Sphinx-autodoc
Django is very nice in that way you can reuse a lot of applications in your projects. It means for big projects that you’ll get a long list of applications in your settings.INSTALLED_APP.
If you’re using Django with Sphinx and want to autodoc all these apps in a wink of an eye, then this app is for you.
- A good combination for documenting your project would be:
sphinx
cartouche to avoid polluting your docstrings with rst syntax
django-giza to generate the doc from your applications
django-sphinxdoc to integrate the sphinx doc in your website
How it works
It will scrape all your .py files in each application listed by INSTALLED_APPS, then add automodules in your PROJECT/SPHINX_ROOT/auto_modules.rst.
You will then see your applications grouped in 2 different categories:
Project Apps are applications located in your project directory
3rd Party Apps are apps which are somewhere in your pythonpath (preferably in your virtualenv)
Good Practices
Add a docstring in your application’s __init__.py file to describe it. django-giza will automatically scrape it for you (although __init.__.py files are excluded by default…)
Install
$ pip install django-giza
Then add giza to your INSTALLED_APPS in settings.py
Usage
$ ./manage.py giza
You can also specify the relative path to your docs root:
$ ./manage.py giza private/documentation
Settings
You can modify some of the settings used by django-giza:
- GIZA_DOCS_ROOT:
Root path for documentation (absolute path required).
- defaults to:
"PROJECT_ROOT/docs"
- GIZA_INDEX_DOC:
Name of your master document.
- defaults to:
"index.rst"
- GIZA_FILENAME:
Name for the generated modules doc.
- defaults to:
"auto_modules"
- GIZA_DOC_TITLE:
Title for the modules page.
- defaults to:
"Python modules"
- GIZA_INTERNAL_TITLE:
Title for the internal apps section.
- defaults to:
"Project Apps"
- GIZA_EXTERNAL_TITLE:
Title for the external apps section.
- defaults to:
"3rd Party Apps"
- GIZA_EXCLUDED_APPS:
List of applications to exclude. Can use wildcard at the end.
defaults to: ["django.*", "giza"]
- GIZA_EXCLUDED_MODULES:
List of filenames to exclude.
defaults to: ["__init__.py"]
- GIZA_AUTOMODULE_OPTIONS:
List of options to the automodule directive, such as “private-members” (without colon delimiters)
- defaults to:
["deprecated", "members", "private-members", "special-members", "show-inheritance"]
TODO
Write tests
improve the not_relevant stuff to auto exclude a file without class or def
Metadata
Release files for django-giza 0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-giza-0.1.6.tar.gz | 6.5 kB | Without provenance | Details for django-giza-0.1.6.tar.gz |
Release files / django-giza-0.1.6.tar.gz
| Download URL | django-giza-0.1.6.tar.gz |
|---|---|
| Size | 6.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a191bdd1e69ea196fbf96c25869ea0512dc348e9fbe39c3f5f61f73804c78f2f
|
|
BLAKE2b-256 checksum How to use checksums |
9858de715908a7e28aceaf2ceb5fecb5f77b897b61668ed57fbeb3de72e88c7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-giza 0.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.