Skip to content
Snippets Groups Projects

docs: Merge all documentation into a single one

Merged Antoine Lambert requested to merge anlambert/swh-docs:docs-single-instance into master

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.

Related to #4496 (closed)

Edited by Antoine Lambert

Merge request reports

Pipeline #144 passed

Pipeline passed for 64e03f5e on anlambert:docs-single-instance

Merged by Antoine LambertAntoine Lambert 2 years ago (Jan 13, 2023 3:24pm UTC)

Loading

Pipeline #145 passed

Pipeline passed for 64e03f5e on master

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
Please register or sign in to reply
Loading