Skip to content

Initalized package documentation - #11

Open
namurphy wants to merge 1 commit into
PlasmaPy:mainfrom
namurphy:sphinx-init
Open

Initalized package documentation#11
namurphy wants to merge 1 commit 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.

Motivation

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

Details

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

Future work

  • Add a Nox session to build the documentation 🤖
  • Add documentation builds to CI 🎛
  • 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 🌱

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