Skip to content
Snippets Groups Projects
  1. Dec 03, 2023
  2. 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
  3. May 10, 2022
  4. Apr 01, 2022
  5. Apr 20, 2020
  6. 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
  7. Aug 29, 2017
Loading