Merge pull request #47 from cms-cat/readthedocs

Add reference documentation

.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

docs/index.md

@@ -0,0 +1,7 @@
+# Overview
+
+The `cmsstyle` library provides a pyROOT-based implementation of the figure guidelines of the CMS Collaboration.
+
+For additional information on CMS plot-style recommendations,
+please see the
+[CMS-internal documentation](https://cms-analysis.docs.cern.ch/).

docs/reference.md

@@ -0,0 +1,13 @@
+# Reference
+
+This part of the project documentation focuses on
+an **information-oriented** approach. Use it as a
+reference for the technical implementation of the
+`cmsstyle` project code.
+
+<!-- ::: cmsstyle.cmsstyle -->
+::: cmsstyle.cmsstyle
+    handler: python
+    options:
+      show_root_heading: false
+      show_source: true

docs/requirements.txt

@@ -0,0 +1,4 @@
+mkdocs-material~=9.5.27
+mkdocs~=1.6.0
+mkdocstrings-python~=1.10.5
+mkdocstrings~=0.25.1

mkdocs.yml

@@ -0,0 +1,12 @@
+site_name: cmsstyle
+
+theme:
+  name: "material"
+
+plugins:
+  - search
+  - mkdocstrings
+
+nav:
+  - Overview: index.md
+  - reference.md