https://github.com/sphinx-notes/project

A Sphinx extension that provides useful directives for creating project documentation
https://github.com/sphinx-notes/project

project-documentation sphinx sphinx-doc sphinx-extension

Last synced: 28 days ago
JSON representation

A Sphinx extension that provides useful directives for creating project documentation

• Host: GitHub
• URL: https://github.com/sphinx-notes/project
• Owner: sphinx-notes
• License: bsd-3-clause
• Created: 2025-02-08T09:32:48.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-10-01T19:38:14.000Z (5 months ago)
• Last Synced: 2025-10-04T10:41:32.963Z (4 months ago)
• Topics: project-documentation, sphinx, sphinx-doc, sphinx-extension
• Language: Python
• Homepage: http://sphinx.silverrainz.me/project/
• Size: 50.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
.. This file is generated from sphinx-notes/cookiecutter.

   You need to consider modifying the TEMPLATE or modifying THIS FILE.

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

sphinxnotes-project

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

.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/project/github-pages

   :target: https://sphinx.silverrainz.me/project

   :alt: Documentation Status

.. |license| image:: https://img.shields.io/github/license/sphinx-notes/project

   :target: https://github.com/sphinx-notes/project/blob/master/LICENSE

   :alt: Open Source License

.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-project.svg

   :target: https://pypi.python.org/pypi/sphinxnotes-project

   :alt: PyPI Package

.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-project

   :target: https://pypi.python.org/pypi/sphinxnotes-project

   :alt: PyPI Package Downloads

|docs| |license| |pypi| |download|

A Sphinx extension that provides useful directives for creating project documentation.

.. INTRODUCTION START 

   (MUST written in standard reStructuredText, without Sphinx stuff)

.. warning::

   Currently, this extension is only used internally in `Sphinx Notes`__ and

   **NO availability/stability guarantees**.

   __ https://sphinx.silverrainz.me/

.. INTRODUCTION END

Please refer to Documentation_ for more details.

.. _Documentation: https://sphinx.silverrainz.me/project