/sphinx-markdown-sample

Markdown based sphinx the documentation generator sample

Primary LanguagePython

rtd-markdown-practice

quick test

see

Sphinx Markdown sample

This is a sample for markdown based sphinx project.

To test

  • Clone this project
  • Install sphinx
  • Install sphinx bootstrap theme: pip install sphinx_bootstrap_theme
  • Install pandoc
  • Make some markdown files. see test.md and test2.md. (index.md has set auto generated.)
  • Make HTML on project root directory. then HTML document will generated in _build/html directory. (with some auto generated HTML files)