sphinxnotes-snippet¶

Introduction¶

Documentations in Sphinx can be parsed into doctree (In other words, Abstract Syntax Tree), all contents of documents are parsed into node of this tree. The Extension collects snippets (doctree nodes) during the build phase of Sphinx, and provide a Command Line Tool for your accessing.

For more details, please refer to Introduction

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-snippet

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

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

Make sure you have snippet command in your $PATH. Rebuild documentation (make build), then invoke snippet stat, the project name is expected to be seen in output.

Contents¶

Contents

Introduction
- How It Works
- What Can This Do
Usage
- Extension
  - Configuration
- Command Line Tool
  - Configuration
Integration
- Bash
- Zsh
- Vim
Change Log
- Version 1.x
- Pre-release 1.x

The Sphinx Notes Project¶

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

The Sphinx Notes Project