diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..5faa470c3 --- /dev/null +++ b/.readthedocs.yml @@ -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 diff --git a/con_test b/con_test new file mode 160000 index 000000000..0edbfbb18 --- /dev/null +++ b/con_test @@ -0,0 +1 @@ +Subproject commit 0edbfbb18185d52fc50289e568f1f9d10b625359 diff --git a/docs/Docker image.rst b/docs/Docker image.rst index 99d32051b..d2848329b 100644 --- a/docs/Docker image.rst +++ b/docs/Docker image.rst @@ -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-`` 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-`` 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`` diff --git a/docs/conf.py b/docs/conf.py index 20435c83a..9170a7f4b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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 @@ -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 @@ -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 @@ -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.