Skip to content

BMaxV/sphinx_tutorial_example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

make new copies the clean project and creates a "docs" folder

use

sphinx-quickstart

options different from default for the quickstart I used:

doc root : new_project/docs separate source and build : y projectname: test author : test_author version : 0.1 autodoc docstrings : y windows cmd file : n

then go to new_project/docs

and execute

make html

This produces a nearly empty index page that goes nowhere and does nothing.

About

an example project documented with sphinx, following the tutorial instructions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors