Welcome to _project_ docs!

Indices and tables

• Index

• Module Index

• Search Page

Guide

• Host reStructured Text Sphinx docs on GitHub Pages
  • Step 01: Project folder
  • Step 02: sphinx-quickstart
  • Step 03: test if setup has been successful
  • Step 04: add python module/package and test setup
    • 04.01 add autodoc and autosummary extensions
    • 04.02 turn on sys.path
    • 04.03 create autosummary templates
    • 04.05 add the autosummary directive
    • 04.05 modify the make file and remove built cache
    • 04.06 locally build the docs and preview
  • Step 05: host static website on GitHub Pages
  • Step 06: github actions to auto build github pages
  • References

API Reference

fibonacci	API reference documentation for the example B package.
multiplication	API reference documentation for the example A package.
mytoolbox	API reference documentation for the example mytoolbox package.