My Brain
My Brain

Sphinx

Create Document

  1. Create venv

  2. Run sphinx-quickstart

  3. Install recommormark:

    pip install --upgrade recommonmark

    Add it to the conf.py file:

    extensions = ['recommonmark']

  4. Install pip install jsx-lexer in case you need pygmentize for jsx syntax.

  5. Create your md files

  6. Add them to the toc in your index.rst:

  .. toctree::
   :maxdepth: 2
   :caption: Contents:

   your_md_file(s)

HTML Tutorial

Tutorial

Backlinks