diff --git a/sysadm/.gitignore b/sysadm/.gitignore new file mode 100644 index 0000000..e76b2db --- /dev/null +++ b/sysadm/.gitignore @@ -0,0 +1,4 @@ +*-stamp +_build/ +/swh-* +sources/ diff --git a/sysadm/Makefile b/sysadm/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/sysadm/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/sysadm/_static b/sysadm/_static new file mode 120000 index 0000000..ead5849 --- /dev/null +++ b/sysadm/_static @@ -0,0 +1 @@ +../docs/_static \ No newline at end of file diff --git a/sysadm/conf.py b/sysadm/conf.py new file mode 100644 index 0000000..6ac16a3 --- /dev/null +++ b/sysadm/conf.py @@ -0,0 +1,3 @@ +from swh.docs.sphinx.conf import * # noqa + +project = "Software Heritage - System Adminitrator Documentation" diff --git a/sysadm/index.rst b/sysadm/index.rst new file mode 100644 index 0000000..897bf88 --- /dev/null +++ b/sysadm/index.rst @@ -0,0 +1,20 @@ +.. sysadm documentation master file, created by + sphinx-quickstart on Thu Oct 7 14:50:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to sysadm's documentation! +================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/sysadm/make.bat b/sysadm/make.bat new file mode 100644 index 0000000..922152e --- /dev/null +++ b/sysadm/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 + +if "%1" == "" goto help + +%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.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/tox.ini b/tox.ini index 213436e..dbc18f5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,43 +1,45 @@ [tox] envlist=flake8,black [testenv] basepython = python3 passenv = SPHINXOPTS SPHINXOPTCOLOR JAVA_HOME [testenv:sphinx] extras = building deps = django < 3 pifpaf setenv = SWHPKGDIR = {envsitepackagesdir}/swh commands = + {envpython} -m pifpaf run postgresql -- make -C sysadm {posargs:html} {envpython} -m pifpaf run postgresql -- make -C users {posargs:html} {envpython} -m pifpaf run postgresql -- make -C docs {posargs:html} [testenv:sphinx-dev] whitelist_externals = make # workaround really long dependencies installation due to the # new pip resolver and its backtracking processes install_command = make pip-install-swh-dev {packages} setenv = SWHPKGDIR = {envsitepackagesdir}/swh commands = + {envpython} -m pifpaf run postgresql -- make -C sysadm {posargs:html} {envpython} -m pifpaf run postgresql -- make -C users {posargs:html} {envpython} -m pifpaf run postgresql -- make -C docs {posargs:html} [testenv:black] skip_install = true deps = black==19.10b0 commands = {envpython} -m black --check swh [testenv:flake8] skip_install = true deps = flake8 commands = {envpython} -m flake8