sphinxnotes-project

Introduction

A Sphinx extension that provides useful directives for creating project documentation

Internal Only

Currently, this project is used only internally by Sphinx Notes and comes with no stability guarantees.

Getting Started

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',
          # …
          ]

Contents

Contents

• Pre-defined sphinxnotes-any Objects
  • The version Object
    • .. version::
      • :date:
      • :break:
    • :version:
    • :version.date:
  • The example Object
    • .. example::
      • :style:
    • :example:
• Change Log

The Sphinx Notes Project

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

The Sphinx Notes Project

• Home
• GitHub
• Blog
• PyPI