docs: Merge all documentations into a single one
These changes allow to build all SWH documentations (developmment, system administration and user) using a single sphinx-build command, meaning they are now merged into a single one with shared index of references. Development documentation is now rooted to docs/devel, user one to docs/user and sysadmin one to docs/sysadm so a good amount of files were moved. A couple of configuration files and makefiles were updated to reflect that change and the building / cleaning processes were made more reliable. Calling make in root directory of swh-docs will execute the development build of the documentation in a tox environment while calling make in docs folder will use the current virtualenv. It remains possible to build each documentation in a standalone way by calling make in their root directory. Closes #4496
Showing
- Makefile.local 2 additions, 0 deletionsMakefile.local
- docs/.gitignore 1 addition, 1 deletiondocs/.gitignore
- docs/Makefile 30 additions, 62 deletionsdocs/Makefile
- docs/_templates/layout.html 0 additions, 21 deletionsdocs/_templates/layout.html
- docs/devel/Makefile 66 additions, 0 deletionsdocs/devel/Makefile
- docs/devel/api-reference.rst 0 additions, 0 deletionsdocs/devel/api-reference.rst
- docs/devel/architecture.rst 0 additions, 0 deletionsdocs/devel/architecture.rst
- docs/devel/architecture/index.rst 0 additions, 0 deletionsdocs/devel/architecture/index.rst
- docs/devel/architecture/metadata.rst 0 additions, 0 deletionsdocs/devel/architecture/metadata.rst
- docs/devel/architecture/overview.rst 0 additions, 0 deletionsdocs/devel/architecture/overview.rst
- docs/devel/archive-changelog.rst 0 additions, 0 deletionsdocs/devel/archive-changelog.rst
- docs/devel/bin/copy-and-fix-subprojects-indices 0 additions, 0 deletionsdocs/devel/bin/copy-and-fix-subprojects-indices
- docs/devel/bin/ln-sphinx-subprojects 39 additions, 0 deletionsdocs/devel/bin/ln-sphinx-subprojects
- docs/devel/bin/py-depgraph 0 additions, 0 deletionsdocs/devel/bin/py-depgraph
- docs/devel/conf.py 1 addition, 0 deletionsdocs/devel/conf.py
- docs/devel/contributing/code-review.rst 0 additions, 0 deletionsdocs/devel/contributing/code-review.rst
- docs/devel/contributing/git-style-guide.rst 0 additions, 0 deletionsdocs/devel/contributing/git-style-guide.rst
- docs/devel/contributing/index.rst 0 additions, 0 deletionsdocs/devel/contributing/index.rst
- docs/devel/contributing/phabricator.rst 0 additions, 0 deletionsdocs/devel/contributing/phabricator.rst
- docs/devel/contributing/python-style-guide.rst 0 additions, 0 deletionsdocs/devel/contributing/python-style-guide.rst
Loading
Please register or sign in to comment