https://github.com/calvinchengx/learnsphinx

A simple example for those who would like to learn how to use python-sphinx to auto-document your Python source code
https://github.com/calvinchengx/learnsphinx

Last synced: 22 days ago
JSON representation

A simple example for those who would like to learn how to use python-sphinx to auto-document your Python source code

• Host: GitHub
• URL: https://github.com/calvinchengx/learnsphinx
• Owner: calvinchengx
• Created: 2013-06-09T04:53:15.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-07-20T13:14:16.000Z (over 1 year ago)
• Last Synced: 2024-11-16T01:37:11.103Z (3 months ago)
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Learn Sphinx

===========

1.  mkvirtualenv --distribute --no-site-packages learnsphinx

2.  cd $PROJECT\_HOME

3.  git clone [email protected]:calvinchengx/learnsphinx.git

4.  cd learnsphinx

5.  pip install sphinx

6.  sphinx-quickstart  # Create docs as root of our documentation

7.  vim docs/source/conf.py and add in

		sys.path.insert(0, os.path.abspath('../..'))

		sys.path.insert(0, os.path.abspath('../../example_project'))

8.  sphinx-apidoc -o docs/source example\_project

9.  cd docs

10. make html

11. open build/html/index.html 

Use sphinx_bootstrap_theme

===============

1.  pip install sphinx\_bootstrap\_theme

2.  vim docs/source/conf.py and add/edit

        import sphinx_bootstrap_theme

		html_theme = 'bootstrap'

		html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

    More customization details [here](https://github.com/ryan-roemer/sphinx-bootstrap-theme)

Generated Documentation

===============

The generated documentation can be found at [readthedocs.org](https://learn-sphinx.readthedocs.org/en/latest/)