Metadata-Version: 2.1
Name: sphinxcontrib-django2
Version: 1.0.1
Summary: Improve the Sphinx autodoc for Django classes.
Home-page: https://github.com/timoludwig/sphinxcontrib-django2
Author: Timo Ludwig
Author-email: ti.ludwig@web.de
License: Apache 2.0
Download-URL: https://github.com/timoludwig/sphinxcontrib-django2/zipball/main
Description: .. image:: https://github.com/timoludwig/sphinxcontrib-django2/workflows/Tests/badge.svg
            :alt: GitHub Workflow Status
            :target: https://github.com/timoludwig/sphinxcontrib-django2/actions?query=workflow%3ATests
        .. image:: https://img.shields.io/pypi/v/sphinxcontrib-django2.svg
            :alt: PyPi
            :target: https://pypi.python.org/pypi/sphinxcontrib-django2/
        .. image:: https://codecov.io/gh/timoludwig/sphinxcontrib-django2/branch/develop/graph/badge.svg
            :alt: Code coverage
            :target: https://codecov.io/gh/timoludwig/sphinxcontrib-django2
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :alt: Black Code Style
            :target: https://github.com/psf/black
        .. image:: https://img.shields.io/github/license/timoludwig/sphinxcontrib-django2
            :alt: GitHub license
            :target: https://github.com/timoludwig/sphinxcontrib-django2/blob/develop/LICENSE
        .. image:: https://readthedocs.org/projects/sphinxcontrib-django2/badge/?version=latest
            :alt: Documentation Status
            :target: https://sphinxcontrib-django2.readthedocs.io/en/latest/?badge=latest
        
        
        sphinxcontrib-django2
        =====================
        
        This is a sphinx extension which improves the documentation of Django apps.
        
        
        Features
        --------
        
        Improvements for the output of Sphinx's autodoc for Django classes:
        
        * List all model and form fields as class parameters
        * Improve model field representations
        * Link related and reverse related fields to the referenced class
        * Hide irrelevant runtime information like ``declared_fieldsets``, ``fieldsets`` and ``Meta`` from
          classes
        * Add information about autogenerated methods
        * Fix intersphinx mappings to Django modules
        * Custom text roles to cross-reference the documentations of Django (``:setting:``,
          ``:templatetag:``, ``:templatefilter:``, ``:fieldlookup:``) and Sphinx (``:event:``,
          ``:confval:``)
        
        This is a fork of `sphinxcontrib-django`_, which seems to be no longer maintained.
        
        .. _sphinxcontrib-django: https://github.com/edoburu/sphinxcontrib-django
        
        
        Installation
        ------------
        
        Install the package via pip:
        
        .. code-block:: bash
        
            pip install sphinxcontrib-django2
        
        
        Configuration
        -------------
        
        Add the following to your Sphinx config file ``conf.py``:
        
        .. code-block:: python
        
            # Add source directory to sys.path
            sys.path.insert(0, os.path.abspath("../src"))
        
            # Add sphinxcontrib_django2 to installed extensions
            extensions = [
                "sphinxcontrib_django2",
            ]
        
            # Configure the path to the Django settings module
            django_settings = "myapp.settings"
        
        
        Contributing
        ------------
        
        Pull requests are always welcome!
        
        You can install all requirements of the development setup with the extras ``dev``, ``test``, ``doc`` and ``optional``:
        
        .. code-block:: bash
        
            python3 -m venv .venv
            source .venv/bin/activate
            pip install -e .[dev,test,doc,optional]
            pre-commit install
        
        Run the tests and generate the coverage report with:
        
        .. code-block:: bash
        
            coverage run
            coverage html
        
        Build the documentation with:
        
        .. code-block:: bash
        
            cd docs
            make html
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: doc
Provides-Extra: optional
