From 1d4593c0e4f90c6aafdc0ccbbe2b349b3667ba15 Mon Sep 17 00:00:00 2001 From: Josef Friedrich Date: Tue, 8 Aug 2023 16:58:11 +0200 Subject: [PATCH] Move docs sources to docs/ folder instead of docs/sources/ --- .gitignore | 110 ++--------------------------- .readthedocs.yaml | 10 ++- Makefile | 2 +- docs/{source => }/conf.py | 0 docs/{source => }/index.rst | 0 docs/{source => }/requirements.txt | 4 -- tox.ini | 3 +- 7 files changed, 17 insertions(+), 112 deletions(-) rename docs/{source => }/conf.py (100%) rename docs/{source => }/index.rst (100%) rename docs/{source => }/requirements.txt (74%) diff --git a/.gitignore b/.gitignore index 8742901..019cff7 100644 --- 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 index 193aa46..89207bf 100644 --- 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 index 993bd1d..9a7a048 100644 --- 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 b/docs/conf.py similarity index 100% rename from docs/source/conf.py rename to docs/conf.py diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/source/requirements.txt b/docs/requirements.txt similarity index 74% rename from docs/source/requirements.txt rename to docs/requirements.txt index f4ff175..a58bbe3 100644 --- a/docs/source/requirements.txt +++ b/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 index da06acc..aa34bf1 100644 --- 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 =