https://github.com/johnandersen777/autoentrypoint

https://github.com/johnandersen777/autoentrypoint

Last synced: about 16 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/johnandersen777/autoentrypoint
• Owner: johnandersen777
• License: mit
• Created: 2021-06-04T19:30:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-06-04T19:31:31.000Z (over 3 years ago)
• Last Synced: 2024-10-24T09:12:10.335Z (25 days ago)
• Language: Python
• Size: 1.95 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
autoentrypoint Sphinx extension

===============================

Sphinx extension for autoclassing every item registered for an entrypoint.

Install from pip

.. code-block:: console

    $ pip install autoentrypoint

Create a Sphinx project

.. code-block:: console

    :test:

    $ sphinx-quickstart --no-sep  --no-makefile --no-batchfile \

        --language english -v 0.0.0 --release 0.0.0 \

        --project "My Project" --author "First Last" docs/

**docs/conf.py**

Add it to your list of extensions.

.. code-block:: python

    :test:

    :filepath: docs/conf.py

    extensions.append("autoentrypoint")

Use the ``autoentrypoint`` directive to have all the classes which are in an

entrypoint to be documented.

**docs/index.rst**

.. code-block:: rst

    :test:

    :filepath: docs/index.rst

    distutils.commands

Run the build.

.. code-block:: console

    :test:

    $ sphinx-build -W -b html docs built_html_docs/