Skip to content
Snippets Groups Projects
  1. Nov 14, 2023
  2. May 22, 2023
  3. Mar 01, 2023
  4. Feb 16, 2023
  5. 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
  6. Nov 29, 2022
  7. Apr 26, 2022
  8. Mar 30, 2022
  9. Feb 22, 2022
  10. Dec 08, 2021
  11. Jul 05, 2021
  12. May 06, 2021
  13. Apr 15, 2021
  14. Apr 09, 2021
  15. Mar 25, 2021
  16. Dec 22, 2020
  17. Oct 08, 2020
  18. Sep 30, 2020
  19. Jul 09, 2020
  20. Apr 28, 2020
  21. Apr 17, 2020
  22. Mar 20, 2020
  23. Nov 22, 2019
  24. Nov 19, 2019
  25. Jul 31, 2019
  26. Jun 03, 2019
  27. May 23, 2019
  28. Dec 06, 2018
  29. Nov 28, 2018
  30. Nov 23, 2018
    • David Douard's avatar
      make-doc: refactor doc build system to build the doc as a whole · 891ad17c
      David Douard authored
      - back to assets only building in each package
      - run sphinx-autodoc on the whole swh package at once
      
      we do not really need a local standalone buildable sphinx project in each swh
      subpackage, so running a full 'make html' in each of them is not required any
      more.
      
      Since we want to build the doc at once instead of building each swh subpackage
      independantly, we need to run apidoc on the whole swh package.
      
      This is done by actually running the apidoc on the pip installed swh
      packages instead of the source repositories, since sphinx-apidoc does
      not seem to support multiple MODULE_PATH as cmdline argument.
      
      So it's best to use tox to build the doc.
      
      Related to T1330.
      891ad17c
  31. Aug 29, 2017
Loading