Rubin user guide websites

User guides help users and team members understand and use your projects with conceptual documentation, how-to procedures, tutorials, and reference documentation. At Rubin Observatory, every software package, web service, and even data release has a corresponding user guide. Documenteer provides a configuration profile for creating branded user guides with Sphinx.

First steps

• Setting up the Documenteer configuration for Rubin user guides
  • Python dependency
  • Create a basic conf.py Sphinx configuration file
  • Create a basic documenteer.toml configuration file
  • Next steps

Advanced configuration details

• Configuring Python projects in documenteer.toml
  • Walkthrough
  • Overriding Python packaging metadata
  • Using alternative labels in pyproject.toml’s [project.urls]
• Extending conf.py directly
  • Adding a package to Intersphinx
  • Adding a Sphinx extension

Configuration reference

• documenteer.toml reference
  • [project] table
  • [project.python]
• The documenteer.conf.guide configuration preset