readthedocs init

Author: DimitriWeiss

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# 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.8"
+  apt_packages:
+    - swig
+    - r-base
+
+sphinx:
+  configuration: conf.py
+
+python:
+  install:
+  - requirements: rtd_requirements.txt

doc/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      = _readthedocs
+
+# 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)

doc/_build/htm/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5e37748cbcd0665b324c3f6e5d207468
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/_build/htm/.doctrees/environment.pickle

@@ -0,0 +1,12 @@
+===============
+rtac
+===============
+
+Welcome to rtac's documentation! Please check out how to install it using the :ref:`installation` guide.
+For information about how to use it and what general functions there are look at the :ref:`usage` section.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation

doc/_build/htm/.doctrees/index.doctree

@@ -0,0 +1,10 @@
+.. _installation:
+
+Installation Guide
+==================
+
+Requirements
+------------
+
+Most of the dependencies will be installed with the pip package.
+

doc/_build/htm/.doctrees/installation.doctree

@@ -0,0 +1,6 @@
+.. _usage:
+
+Usage
+=====
+
+xxx