Move docs sources to docs/ folder instead of docs/sources/

Josef-Friedrich · Aug 8, 2023 · 1d4593c · 1d4593c
1 parent 28031c4
commit 1d4593c
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 112 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,125 +1,27 @@
+# Based on https://github.com/github/gitignore/blob/main/Python.gitignore
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
-*$py.class
-
-# C extensions
-*.so
 
 # Distribution / packaging
-.Python
-build/
-develop-eggs/
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
 MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
+*.egg-info/
+*.venv/
 
 # Unit test / coverage reports
-htmlcov/
 .tox/
-.nox/
-.coverage
-.coverage.*
-.cache
 nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
 .pytest_cache/
 
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
 # Sphinx documentation
 docs/_build/
 
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
-#.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don’t work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
+# .python-version
 
 # mypy
 .mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
 
-debug.txt
+*.pickle
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,15 +1,21 @@
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
 version: 2
 
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#build
 build:
   os: "ubuntu-22.04"
   tools:
     python: "3.10"
 
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx
 sphinx:
-  configuration: docs/source/conf.py
+  configuration: docs/conf.py
 
+# https://docs.readthedocs.io/en/stable/config-file/v2.html#python
 python:
   install:
-    - requirements: docs/source/requirements.txt
+    - requirements: docs/requirements.txt
     - method: pip
       path: .
diff --git a/Makefile b/Makefile
@@ -23,6 +23,6 @@ test_38:
 
 docs:
 	poetry run tox -e docs
-	xdg-open .tox/docs/tmp/html/index.html
+	xdg-open docs/_build/index.html
 
 .PHONY: build upload test readme docs
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/source/requirements.txt → docs/requirements.txt b/docs/source/requirements.txt → docs/requirements.txt
@@ -3,7 +3,3 @@
 Sphinx==6.2.1
 sphinx-rtd-theme==1.2.2
 sphinx-autodoc-typehints==1.22.0
-
-pgi==0.0.11.2
-nagiosplugin==1.3.3
-check_systemd
diff --git a/tox.ini b/tox.ini
@@ -25,7 +25,8 @@ deps =
     Sphinx==6.2.1
     sphinx-rtd-theme==1.2.2
     sphinx-autodoc-typehints==1.22.0
-commands = sphinx-build -q -b html docs/source {envtmpdir}/html
+commands =
+    sphinx-build -W -q docs docs/_build
 
 [testenv:lint]
 deps =