From b45037b66d0774f0fd009ebced1562393b81e41c Mon Sep 17 00:00:00 2001 From: Magnus Wahlberg Date: Tue, 21 Nov 2023 16:17:33 +0100 Subject: [PATCH] rtd fix --- .idea/fake_vcf.iml | 2 +- .idea/misc.xml | 2 +- .idea/poetry.xml | 10 ++++++++++ docs/Makefile | 20 ++++++++++++++++++++ docs/conf.py | 16 ++++++++++++++-- docs/requirements.txt | 4 ++-- 6 files changed, 48 insertions(+), 6 deletions(-) create mode 100644 .idea/poetry.xml create mode 100644 docs/Makefile diff --git a/.idea/fake_vcf.iml b/.idea/fake_vcf.iml index 4a74969..0e08257 100644 --- a/.idea/fake_vcf.iml +++ b/.idea/fake_vcf.iml @@ -4,7 +4,7 @@ - + diff --git a/.idea/misc.xml b/.idea/misc.xml index c739f68..91bb01a 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -3,5 +3,5 @@ - + diff --git a/.idea/poetry.xml b/.idea/poetry.xml new file mode 100644 index 0000000..50cae1e --- /dev/null +++ b/.idea/poetry.xml @@ -0,0 +1,10 @@ + + + + + + diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /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 = source +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 index 8acf0ba..7d629fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,14 +13,26 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = [ + "sphinx.ext.duration", + "sphinx.ext.doctest", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", +] + templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), +} +intersphinx_disabled_domains = ["std"] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "alabaster" +html_theme = "sphinx_rtd_theme" html_static_path = ["_static"] diff --git a/docs/requirements.txt b/docs/requirements.txt index 53fc1f3..c625976 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -sphinx==7.1.2 -sphinx-rtd-theme==1.3.0rc1 +sphinx==7.2.6 +sphinx-rtd-theme==1.3.0