Skip to content

Markdown based sphinx the documentation generator sample

Notifications You must be signed in to change notification settings

agurianov/sphinx-markdown-sample

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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)

About

Markdown based sphinx the documentation generator sample

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 60.5%
  • Shell 39.5%