Intro

Getting started

Creating a resource file for Sphinx

Setting the source path

Generating documentation for multiple modules

Generating HTML pages

Viewing the generated HTML pages in Firefox

Using Sphinx's Spanked RTD theme

Conclusion

Installing Sphinx

Basics of Sphinx

The Sphinx Quick Start Command

Sphinx Quick Start

Skeleton Files

Configuration Script

Index Rst

The Great Sphinx

Sphinx

Flowing Water

Khufu

Face

The Great Sphinx of Giza

The Tomb of Kafree's Priests

The Temple

Lion

The Resurrection Machine

Reshama introduces Data Umbrella

Reshama introduces Melissa

Tutorial Introduction

How Melissa got involved with NumPy / Invitation to collaborate with numpy documentation

What is documentation? (Tutorials, How-to Guides, Explanation, Reference)

configuration file: conf.py

Getting started with sphinx (installation) (conf.py, index.rst, _build/html)

demo of MinimalSphinx Project

What is reStructuredText?

comparing reStructuredText (reST) to Markdown (md)

Auto-documenting a python package (autodoc)

Q&A: Do the docstrings have to be in rst?

Other extensions (sphinx.ext.doctest, sphinx.ext.intersphinx)

run "make html" command

Q&A: Should we consider doctest vs pytest? (They are complementary. Use both.)

Getting involved with NumPy, Communicating

Fixing a Typo in NumPy Docs

Fork numpy repo on GitHub

Add remote: git remote add upstream

Branch: git checkout -b doc_fix

Set up virtual environment

build the docs: "cd doc", "make html"

Q&A: Can sphinx be used for other languages? (yes)

Jupyter notebooks

Q&A: Why do we build from source?

The History of the Sphinx

What is the Sphinx?

The Divine Names of the Sphinx

Why Did Caffrey Put His Face on the Body of a Lion

Lydia Mcknight

Did Khafre Want To Be Seen as a God

The Natural Layers

Who Built The Sphinx?

The Formation of the Sphinx

The Geological Signatures

Matching The Blocks

The Sphinx's Face

Sphinx Repairs

The Sphinx's Connection To The Rock

Saving The Sphinx

Introduction and documentation discussion

Creating documentation from source code

Introduction to Sphinx

The Python Docstring

Installation and setup of Sphinx

Customizing your Sphinx output

Example project

Read the Docs

Alternatives to restructured text

Pylint

Deployment

The Sphinx Yaml File

Php Import

Sphinx Quick Start

Github Actions

Github Workflow To Access Github Pages

Deploy from Branch

Recap

Run Sphinx Quick Start

Deploy Pages Build Deployment

Intro

Sphinx Extensions

Separate source and build directories

Create makefile and batch file

Sphinx configuration file

Index file

Samples in code C

Viewing the HTML page in Google Chrome

Changing Default Theme

Summary

Intro

Sphinx Quickstart

Sphinx Configuration

Sphinx basic file structure

Sphinx themes

Create another.rst file

Highlighting Python code

Indentation and Highlighting

Introduction

Henry Salt's forgotten manuscripts

Cavigula's work at Giza

Napoleon Bonaparte in Egypt, the Internet Archive

Finding Salt's manuscripts

Details of Cavigula's dig and discoveries

The Dream Stele

What's beneath the Sphinx?

The Roman Staircase

Discussion on the age of the Sphinx

Re-carving the Sphinx's head, conclusion

Post-script

The Great Sphinx of Giza

The Old Sphinx Temple

Pharaoh Khafre

Pyramid of Khafre

The Keeper of Wisdom

The Giza Plateau

Sphinx

The Pyramid of Catherine

The Sphinx

Osiris

Burial Site

The Egyptian Sphinx

What is Sphinx?

Getting started

Sphinx Quickstart

Sphinx source file suffix

Creating project and code pages

Adding a project page

Configuring Sphinx to find your code

Cleaning up and rebuilding the documentation

Conclusion