https://github.com/dougthor42/sphinx_test

Playing around with Sphinx and trying to get docs built
https://github.com/dougthor42/sphinx_test

Last synced: 6 days ago
JSON representation

Playing around with Sphinx and trying to get docs built

• Host: GitHub
• URL: https://github.com/dougthor42/sphinx_test
• Owner: dougthor42
• License: mit
• Created: 2015-08-04T17:47:28.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-04T22:26:49.000Z (over 9 years ago)
• Last Synced: 2024-03-15T12:11:21.690Z (10 months ago)
• Language: Python
• Homepage: http://dougthor42.github.io/sphinx_test
• Size: 727 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# sphinx_test

Playing around with Sphinx and trying to get docs built

# Steps:

1. sphinx-quickstart

    - path = .\\doc

    - make sure to say yes to autodoc extension

2. add ``'sphinx.ext.napoleon'`` to extensions in doc\\conf.py

3. Change html_theme to ``'sphinx_rtd_theme'`` in doc\\conf.py

4. Add modules to sys.path in doc\\conf.py

4. Run sphinx-apidoc -f -o doc sphinx_test from trunk\\sphinx_test

5. ``cd doc``

6. ``make.bat html``

7. View html at trunk\\sphinx_test\\doc\\_build\html