[doxygen] Set up readthedocs configuration

.github/workflows/build.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches-ignore:
       - master
+      - readthedocs
       - nobuild/**
   pull_request:
 

README.md

@@ -24,7 +24,7 @@ Resources
 
 [:globe_with_meridians: Website](https://swift-project.org/)
 
-[:blue_book: User documentation](https://docs.swift-project.org/)
+[:green_book: User guide](https://docs.swift-project.org/)
 
 [:wave: Discord](https://discord.gg/R7Atd9A)
 
@@ -42,3 +42,5 @@ Pull requests should be made against the current active development branch,
 which is `develop/0.9.6`.
 
 [:blue_book: Developer guide](https://docs.swift-project.org/doku.php?id=developer_documentation)
+
+[:orange_book: API documentation](https://apidocs.swift-project.org/)

docs/conf.py

@@ -0,0 +1,80 @@
+# 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
+
+import os
+import json
+import subprocess
+
+swift_config_file = open('../default.json')
+swift_config = json.load(swift_config_file)
+swift_config_file.close()
+
+
+# -- 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 = 'swift pilot client'
+copyright = '2020, swift Project Community / Contributors'
+author = 'swift Project Community / Contributors'
+
+version = '.'.join([ str(swift_config['version']['major']),
+                     str(swift_config['version']['minor']),
+                     str(swift_config['version']['micro']) ])
+release = version
+
+
+# -- 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 = []
+
+# 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']
+
+html_baseurl = 'https://apidocs.swift-project.org/'
+html_copy_source = False
+html_show_sourcelink = False
+
+
+# -- Run Doxygen -------------------------------------------------------------
+
+# https://stackoverflow.com/questions/36064976/using-doxygen-in-read-the-docs
+html_extra_path = ['html']
+
+env = {
+    'DOXY_SRC_ROOT': '..'
+}
+subprocess.run(['doxygen', 'Doxyfile.qmake'], env=env, check=True)

readthedocs.yml

@@ -0,0 +1,8 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+  configuration: docs/conf.py