Skip to content

Initalize package documentation - #11

Merged
namurphy merged 12 commits into
PlasmaPy:mainfrom
namurphy:sphinx-init
Sep 2, 2026
Merged

Initalize package documentation#11
namurphy merged 12 commits into
PlasmaPy:mainfrom
namurphy:sphinx-init

Conversation

@namurphy

@namurphy namurphy commented Aug 26, 2026

Copy link
Copy Markdown
Member

Description

Added the framework for building documentation with Sphinx, with the markup syntax set to reStructuredText by default.

Documentation can now be built with nox -s docs in the top-level directory of the repository.

Motivation

If code isn't documented, it doesn't exist.

Details

After installing sphinx, I ran sphinx-quickstart and followed the prompts.

I also added the docs session to noxfile.py. The documentation can now be built by running nox -s docs in the top-level directory of the repository.

Future work

  • Decide on a theme! Probably something from the diataxis model for docs?
  • Finalize the name of the package 📛
  • Creating a Read the Docs page for the documentation 📚
  • Enable autodoc so that the documentation strings (docstrings) showing how to use each function get built into the documentation
  • Enable awesome Sphinx extensions that are awesome 🌱

@namurphy namurphy changed the title Initalized package documentation Initalize package documentation Sep 2, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My main motivation for adding this file is so that the directory shows up when docs are built in CI, and git only tracks files, not directories...

@namurphy
namurphy merged commit f9fc578 into PlasmaPy:main Sep 2, 2026
11 checks passed
@namurphy
namurphy deleted the sphinx-init branch September 2, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant