sphinxnotes-project¶

Introduction¶

A Sphinx extension that provides useful directives for creating project documentation

Warning

Currently, this extension is only used internally in Sphinx Notes and NO availability/stability guarantees.

Note

We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.

First, downloading extension from PyPI:

$ pip install sphinxnotes-project

Then, add the extension name to extensions configuration item in your conf.py:

extensions = [
          # …
          'sphinxnotes.project',
          # …
          ]

Check out Usage for all available directives.

Contents

The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project