Skip to content

Documentation Guide for URSSI Summer School

This documentation is built using MkDocs and is hosted on GitHub Pages.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

External Resources

  1. Scientific Python documentation guide - Focused on creating docs using Sphinx with Myst (markdown)
  2. PyOpenSci documentation guide - Worth reading for a different perspective on writing documentation, with more focus on the why and how. Uses Sphinx, but this is not the core part of the documentaiton.