Skip to content
Snippets Groups Projects
  1. Nov 20, 2023
    • David Douard's avatar
      Add a hook to ensure README files are symlinked in swh-xxx/docs/ · 58d0e965
      David Douard authored
      The idea is to generalize the fact that all the swh packages should have
      a README file in the root directory, but this should be included in the
      sphinx documentation, for which the simplest way is to make the file
      symlinked in docs/. For several reasons, it's simpler to make this
      symlink creation handled by a hook/automation script at doc build time
      rather than add the symlink in the git repo of the swh package.
      58d0e965
  2. Jan 13, 2023
    • Antoine Lambert's avatar
      docs: Merge all documentations into a single one · 0e55968d
      Antoine Lambert authored
      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
      0e55968d
Loading