Skip to content

README.md

Latest commit

 

History

History
28 lines (19 loc) · 728 Bytes

README.md

File metadata and controls

28 lines (19 loc) · 728 Bytes

sphinx-tutorial

This repo is hosting the source files for the sphinx-tutorial website.

This workshop will walk you through the steps of using the Sphinx tool for documentation generation for a Python API, hosting them on GitHub Pages and automatically creating new versions on code updates.

Accompanying the instructions there is this example project where you can find some sample code to serve as a base for the rest of the workshop.

Development

  • Install the dependencies:

    bundle install

  • Build and serve the site:

    bundle exec jekyll serve

  • Navigate to http://127.0.0.1:4000 to enjoy!