From 028d00856db313a4fee83e92c5848a8cfecf50d2 Mon Sep 17 00:00:00 2001 From: Rohith Varma Buddaraju Date: Wed, 3 Aug 2022 20:12:25 +0530 Subject: [PATCH 1/3] Add the docs folder --- docs/Makefile | 20 ++++++++++++++++ docs/conf.py | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 23 ++++++++++++++++++ 3 files changed, 107 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..52538a9 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,64 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# 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 +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = "tardis-setups" +copyright = "2022, Wolfgang Kerzendorf" +author = "Wolfgang Kerzendorf" + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx_gallery.gen_gallery", +] + +sphinx_gallery_conf = { + "examples_dirs": [ + "../tardis-setups/2014", + "../tardis-setups/2020", + ], # path to your example scripts + "gallery_dirs": [ + "2014_examples", + "2020_examples", + ], # path to where to save gallery generated output +} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "sphinx_rtd_theme" + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..1c2f561 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ +.. tardis-setups documentation master file, created by + sphinx-quickstart on Mon Jun 20 17:55:16 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to tardis-setups's documentation! +========================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +.. toctree:: + :maxdepth: 2 + :caption: Galleries: + + 2014_examples/index + 2020_examples/index + +Indices and tables +================== + +* :ref:`genindex` From ef2ff7dadf81ee45948493bc71627cf80b569b92 Mon Sep 17 00:00:00 2001 From: Rohith Varma Buddaraju Date: Mon, 8 Aug 2022 20:19:00 +0530 Subject: [PATCH 2/3] Change copyright in conf file of the documentation --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 52538a9..097e8ef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = "tardis-setups" -copyright = "2022, Wolfgang Kerzendorf" +copyright = "2022, TARDIS RT Collaboration" author = "Wolfgang Kerzendorf" From 938ab47398d29954273918f16fa22be7bbc80d54 Mon Sep 17 00:00:00 2001 From: Rohith Varma Buddaraju Date: Mon, 8 Aug 2022 20:19:35 +0530 Subject: [PATCH 3/3] Remove default comments in the index file of documentation --- docs/index.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 1c2f561..20c689c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,3 @@ -.. tardis-setups documentation master file, created by - sphinx-quickstart on Mon Jun 20 17:55:16 2022. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to tardis-setups's documentation! =========================================