Skip to content
Snippets Groups Projects
  1. Mar 01, 2023
  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
    • Antoine Lambert's avatar
      tox: Add support for tox 4.x · e2308580
      Antoine Lambert authored
      Some deprecated tox 3.x features have been removed in tox 4.x
      and some install behaviors changed between the two versions.
      
      So add tox 4.x support while keeping tox >= 3.7 compatibility.
      e2308580
  3. Oct 18, 2022
  4. Apr 08, 2022
  5. Oct 14, 2021
  6. Oct 11, 2021
  7. Jun 18, 2021
  8. Apr 15, 2021
  9. Apr 14, 2021
    • Antoine Lambert's avatar
    • Antoine Lambert's avatar
      tox/sphinx-dev: Workaround really long dependencies installation · 31bf3482
      Antoine Lambert authored
      The new pip resolver ends up backtracking numerous packages when
      installing all depencies in a single pip command but this is
      terribly slow and long to execute.
      
      A workaround is to install each swh package one at a time by
      executing pip multiple times, no backtracking happens in that
      case and it reduces considerably the overall installation time.
      
      Another advantage of proceeding like this is that it ensures each
      swh package will be installed in development mode.
      
      Also increase tox verbosity when calling make to have some feeback
      of what it is doing.
      31bf3482
  10. Oct 02, 2020
  11. Jul 17, 2020
  12. Jul 09, 2020
  13. Apr 30, 2020
  14. Apr 29, 2020
  15. Apr 28, 2020
    • David Douard's avatar
      Refactor the sphinx-dev build environment to get rid of the link-stamp step · 457c9f64
      David Douard authored
      by installing swh packages in standard (non-editable) mode, so we have an
      easy to specify swh/ directory in which all the swh packages are installed.
      
      The main drawback of this solution is we loose the possibility of rebuilding
      the doc (in tox) while editing a package's documentation without rebuilding
      the tox env (i.e. using tox -r). But IMHO this usage has never been
      adpoted by anyone, so it's much simpler that way.
      457c9f64
  16. Apr 08, 2020
  17. Nov 21, 2019
  18. Oct 07, 2019
  19. Nov 29, 2018
    • David Douard's avatar
      Put swh dependencies in a dedicated extra requirements · 53326b7d
      David Douard authored
      to prevent weird race condition when both requirements-swh.txt and
      requirements-swh-dev.txt are added as requirements.
      
      This is needed to make:
      
        tox -e sphinx-dev
      
      work as expected, ie. with swh packages installed from sources rather than
      from pypi.
      53326b7d
  20. Nov 28, 2018
  21. Nov 23, 2018
    • David Douard's avatar
    • David Douard's avatar
      tox: add a sphinx-dev tox environment · 0e0c8548
      David Douard authored
      that builds the doc using source code repos located one directory above
      instead of published versions of swh subpackages.
      
      Related to T1330.
      0e0c8548
    • 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
Loading