diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..58a761e --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +_build/ +apidoc/ +*-stamp diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..c30c50a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1 @@ +include ../../swh-docs/Makefile.sphinx diff --git a/docs/_static/.placeholder b/docs/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/_templates/.placeholder b/docs/_templates/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..190deb7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from swh.docs.sphinx.conf import * # NoQA diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2c63e19 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,4 @@ +.. _swh-graphql: + +Software Heritage - GraphQL APIs +================================ diff --git a/tox.ini b/tox.ini index 58960a2..e10c6cd 100644 --- a/tox.ini +++ b/tox.ini @@ -1,72 +1,53 @@ [tox] envlist=black,flake8,mypy,py3 [testenv] extras = testing deps = pytest-cov commands = pytest {envsitepackagesdir}/swh/graphql \ --cov={envsitepackagesdir}/swh/graphql \ --cov-branch {posargs} [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 [testenv:mypy] extras = testing deps = mypy==0.920 commands = mypy swh -# # build documentation outside swh-environment using the current -# # git HEAD of swh-docs, is executed on CI for each diff to prevent -# # breaking doc build -# [testenv:sphinx] -# whitelist_externals = make -# usedevelop = true -# extras = -# testing -# deps = -# # fetch and install swh-docs in develop mode -# -e git+https://forge.softwareheritage.org/source/swh-docs#egg=swh.docs - -# setenv = -# SWH_PACKAGE_DOC_TOX_BUILD = 1 -# # turn warnings into errors -# SPHINXOPTS = -W -# commands = -# make -I ../.tox/sphinx/src/swh-docs/swh/ -C docs - - -# # build documentation only inside swh-environment using local state -# # of swh-docs package -# [testenv:sphinx-dev] -# whitelist_externals = make -# usedevelop = true -# extras = -# testing -# deps = -# # install swh-docs in develop mode -# -e ../swh-docs +# build documentation outside swh-environment using the current +# git HEAD of swh-docs, is executed on CI for each diff to prevent +# breaking doc build +[testenv:sphinx] +whitelist_externals = make +usedevelop = true +extras = + testing +deps = + # fetch and install swh-docs in develop mode + -e git+https://forge.softwareheritage.org/source/swh-docs#egg=swh.docs -# setenv = -# SWH_PACKAGE_DOC_TOX_BUILD = 1 -# # turn warnings into errors -# SPHINXOPTS = -W -# commands = -# make -I ../.tox/sphinx-dev/src/swh-docs/swh/ -C docs +setenv = + SWH_PACKAGE_DOC_TOX_BUILD = 1 + # turn warnings into errors + SPHINXOPTS = -W +commands = + make -I ../.tox/sphinx/src/swh-docs/swh/ -C docs