Skip to content
Snippets Groups Projects
Verified Commit 8befc797 authored by Antoine R. Dumont's avatar Antoine R. Dumont
Browse files

Bootstrap new sysadm documentation instance

Related to T3154
parent 60f9bb1d
No related branches found
No related tags found
No related merge requests found
*-stamp
_build/
/swh-*
sources/
# 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)
../docs/_static
\ No newline at end of file
from swh.docs.sphinx.conf import * # noqa
project = "Software Heritage - System Adminitrator Documentation"
.. 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`
@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
......@@ -14,6 +14,7 @@ deps =
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}
......@@ -25,6 +26,7 @@ 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}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment