AnyBody Sphinx template

This template is used to easily create sphinx pages using Markdown. It uses the sphinx book theme, but can be easily changed:

Pages are written in MyST Markdown which makes it easy write basic pages, while maintaining the full power of sphinx.

Quickstart

All documenation files are placed in the Docs/ subfolder. They can be moved if another directory structure if needed.

The template uses Pixi as a package manager. See the pixi.toml file for available commands.

1. Customize the Docs/conf.py file to adapt project as needed. (delete quickstart.md and customize/).

2. To build the sphinx documenation's HTML pages run the following: 🎉

   pixi run html
   

3. To build the PDF version run:

   pixi run pdf
   

Development tips/tricks

• Use vscode for development
• Install MyST vscode extension to enable syntax highlighting markdown files.
• See the following resources for how to write pages:
  • Markup reference for basic syntax.
  • Sphinx design for adavanced html elements