From afa012baf397aecaaf91d8bf5697cfa575102c19 Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Fri, 13 Sep 2024 14:04:46 +0200 Subject: [PATCH 1/8] Add empty sphinxdocs-dir --- docs/Makefile | 20 ++++++++++++++++++++ docs/conf.py | 28 ++++++++++++++++++++++++++++ docs/index.rst | 17 +++++++++++++++++ docs/make.bat | 35 +++++++++++++++++++++++++++++++++++ 4 files changed, 100 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d4bb2cbb --- /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 = . +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 new file mode 100644 index 00000000..8999710a --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,28 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Zino' +copyright = '2024, Morten Brekkevold, Johanna England, Simon Tveit' +author = 'Morten Brekkevold, Johanna England, Simon Tveit' +release = '2.0.0-beta.2' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..75088eff --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. Zino documentation master file, created by + sphinx-quickstart on Fri Sep 13 14:02:10 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Zino documentation +================== + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..954237b9 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd From 8d5d052b7b9eb9a70fa878c01ac5ec7265590147 Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Fri, 13 Sep 2024 14:06:31 +0200 Subject: [PATCH 2/8] Add docs/_build to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 91950cd1..2dbe18af 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ dist/ # Generated files src/zino/version.py old-events/ +docs/_build/ .coverage *.pyc *.egg-info/ From baefeac3af9d24987f8005383347ac6d7ef5045f Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Fri, 13 Sep 2024 14:10:45 +0200 Subject: [PATCH 3/8] Add .readthedocs.yaml --- .readthedocs.yaml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..f89fc906 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,32 @@ +# .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 OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt From 71eacc389c4d099f69f4a3bd9e66a0410a73f931 Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Fri, 13 Sep 2024 14:19:33 +0200 Subject: [PATCH 4/8] Add changelog fragment --- changelog.d/+add-docs-dir.added.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelog.d/+add-docs-dir.added.md diff --git a/changelog.d/+add-docs-dir.added.md b/changelog.d/+add-docs-dir.added.md new file mode 100644 index 00000000..79510675 --- /dev/null +++ b/changelog.d/+add-docs-dir.added.md @@ -0,0 +1,2 @@ +Added directory for sphinx docs in order to setup up read the docs and secure +the name "zino" there. From a3751987f70764a801de0706eb0b4caf7fdfbef4 Mon Sep 17 00:00:00 2001 From: Johanna England Date: Wed, 18 Sep 2024 06:46:06 +0200 Subject: [PATCH 5/8] Make black and ruff ignore docs dir --- pyproject.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 72c32c2b..1d64ee99 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -95,6 +95,7 @@ force-exclude = ''' | build | dist | src/zino/mibdumps + | docs ) ) ''' @@ -103,7 +104,7 @@ force-exclude = ''' line-length = 120 target-version = "py39" exclude = [ - "mibdumps" + "mibdumps", "docs" ] # Exclude files even when passed directly as argument (for MegaLinter) force-exclude = true From e6a24c3642dba12d6feda2733d614a097dc18c20 Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Thu, 19 Sep 2024 11:44:52 +0200 Subject: [PATCH 6/8] Update .readthedocs.yaml Co-authored-by: Morten Brekkevold --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f89fc906..ff76992f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.12" + python: "3.11" # You can also specify other tool versions: # nodejs: "19" # rust: "1.64" From dc66f271cc83771fe95bb51640aad4ca5ed24bec Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Thu, 19 Sep 2024 11:45:06 +0200 Subject: [PATCH 7/8] Update changelog.d/+add-docs-dir.added.md Co-authored-by: Johanna England --- changelog.d/+add-docs-dir.added.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/+add-docs-dir.added.md b/changelog.d/+add-docs-dir.added.md index 79510675..543e6e99 100644 --- a/changelog.d/+add-docs-dir.added.md +++ b/changelog.d/+add-docs-dir.added.md @@ -1,2 +1,2 @@ -Added directory for sphinx docs in order to setup up read the docs and secure +Added directory for sphinx docs in order to set up read the docs and secure the name "zino" there. From 92a0727ebc7122a19ab9bea4a583db173b08f792 Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Thu, 19 Sep 2024 11:45:20 +0200 Subject: [PATCH 8/8] Update docs/conf.py Co-authored-by: Morten Brekkevold --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8999710a..670a1340 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,7 +7,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'Zino' -copyright = '2024, Morten Brekkevold, Johanna England, Simon Tveit' +copyright = '2024, Sikt - The Norwegian Agency for Shared Services in Education and Research' author = 'Morten Brekkevold, Johanna England, Simon Tveit' release = '2.0.0-beta.2'