Skip to content

Commit

Permalink
Update ReadTheDocs configuration.
Browse files Browse the repository at this point in the history
Plus a small clarification to the documentation.
  • Loading branch information
wil93 committed Oct 8, 2024
1 parent a7d4643 commit c66fcc3
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 14 deletions.
13 changes: 13 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.12"

sphinx:
configuration: docs/conf.py
1 change: 1 addition & 0 deletions con_test
Submodule con_test added at 0edbfb
6 changes: 3 additions & 3 deletions docs/Docker image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ is similar to:
We recommend adding yourself to the ``docker`` group.

What the ``cms-test.sh`` command does is: first build a fresh CMS image when
necessary, and then create (assuming you didn't specify the ``-p`` flag) a
``cms-testdb-1`` container for the database, and a
``cms-testcms-run-<random_string>`` container for CMS.
necessary, and then create (assuming you are on the ``main`` git branch) a
``main-testdb-1`` container for the database, and a
``main-testcms-run-<random_string>`` container for CMS.

The database container **will not** be automatically deleted, while the CMS
container will be automatically deleted upon exiting (because of the ``--rm``
Expand Down
26 changes: 15 additions & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
# serve to show the default.

import sys, os
from datetime import datetime

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -40,8 +41,9 @@
master_doc = 'index'

# General information about the project.
project = u'CMS'
copyright = u'2020, The CMS development team'
project = "CMS"
_current_year = datetime.now().year
copyright = f"{_current_year}, The CMS development team"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -183,8 +185,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'cms.tex', u'CMS Documentation',
u'The CMS development team', 'manual'),
("index", "cms.tex", "CMS Documentation", "The CMS development team", "manual"),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -212,10 +213,7 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'CMS', u'CMS Documentation',
[u'The CMS development team'], 1)
]
man_pages = [("index", "CMS", "CMS Documentation", ["The CMS development team"], 1)]

# If true, show URL addresses after external links.
#man_show_urls = False
Expand All @@ -227,9 +225,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'CMS', u'CMS Documentation',
u'The CMS development team', 'CMS', 'Contest Management System.',
'Miscellaneous'),
(
"index",
"CMS",
"CMS Documentation",
"The CMS development team",
"CMS",
"Contest Management System.",
"Miscellaneous",
),
]

# Documents to append as an appendix to all manuals.
Expand Down

0 comments on commit c66fcc3

Please sign in to comment.