Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MicroCloud doc integration #372

Merged
merged 9 commits into from
Aug 20, 2024
Merged

Commits on Aug 13, 2024

  1. doc/Makefile: use doc/Makefile instead of doc/Makefile.sp

    doc/Makefile.sp comes from the starter pack and should not be
    changed. Therefore, we'll need to add our own targets to doc/Makefile.
    And that means we must use that file. ;)
    
    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    6b3c968 View commit details
    Browse the repository at this point in the history

Commits on Aug 16, 2024

  1. doc/integration: update the doc build to integrate other doc sets

    Download the other doc sets and build them, integrated with the
    MicroCloud docs.
    You can still run `make doc-microcloud` to build the single
    MicroCloud documentation.
    
    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    fdaaa47 View commit details
    Browse the repository at this point in the history

Commits on Aug 19, 2024

  1. doc/integration: add targets for RTD and fix the build steps

    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    fc730ef View commit details
    Browse the repository at this point in the history
  2. doc/tests: make the doc tests use the custom Makefile

    By default, the workflows use Makefile.sp, but we want them to use
    our customised targets.
    
    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    3997c6d View commit details
    Browse the repository at this point in the history
  3. doc/integration: make the search bar pop up RTD search

    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    471fc32 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    a4bd865 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    2602c36 View commit details
    Browse the repository at this point in the history
  6. doc/integration: fix version handling

    Allow specifying the version for each doc set, and make sure to
    reset the Git repos to use it.
    
    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    3c80d2c View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2024

  1. doc/integration: add canonical URLs for the other doc sets

    To let Google know that these are copies of the original doc
    sets, add a rel="canonical" link element (see
    https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls ).
    
    This is achieved by setting Sphinx's `html_baseurl` configuration.
    
    Signed-off-by: Ruth Fuchss <[email protected]>
    ru-fu committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    9b5d0fd View commit details
    Browse the repository at this point in the history