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.

Sign up for GitHub

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

Jump to bottom

Convert wiki to Sphinx/ReadTheDocs (REP-004 part 1) #1522

Merged
merged 30 commits into from
Sep 14, 2023
Merged

Convert wiki to Sphinx/ReadTheDocs (REP-004 part 1) #1522

merged 30 commits into from
Sep 14, 2023

Commits on Aug 27, 2023

  1. Remove docs folder 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    0519834 View commit details
    Browse the repository at this point in the history

  2. Experiment with sphinx docs for API 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    9c2c87d View commit details
    Browse the repository at this point in the history

  3. Start to migrate wiki to RTD 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    4810557 View commit details
    Browse the repository at this point in the history

  4. More progress. Package definition, package commands and variants docs… 

    … are now migrated. With all the interlinking (or at least as much as possible).

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    1eaf4a9 View commit details
    Browse the repository at this point in the history

  5. Silence Sphinx about cached_property not being a callable 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    7699af3 View commit details
    Browse the repository at this point in the history

  6. Add ephemerals doc 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    586e20a View commit details
    Browse the repository at this point in the history

  7. Move rez-config docs generation into a sphinx extension with a custom… 

    … directive

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    1e62245 View commit details
    Browse the repository at this point in the history

  8. Add logo 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    b223972 View commit details
    Browse the repository at this point in the history

  9. Add text on front page 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    eb864a6 View commit details
    Browse the repository at this point in the history

  10. Add building packages, context, context bundles and suites pages 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    84a3b34 View commit details
    Browse the repository at this point in the history

  11. Use nitpick mode by default 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    4cfedbb View commit details
    Browse the repository at this point in the history

  12. Invalidate the configure_rez doc if rezconfig.py changed. This will f… 

    …orce a re-build of configuring_rez.

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    e55ee33 View commit details
    Browse the repository at this point in the history

  13. Fix garbage rendering of the "Configuring rez" document. 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    2f9ca98 View commit details
    Browse the repository at this point in the history

  14. Remove unnecessary exclude_patterns from sphinx config 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    683e16f View commit details
    Browse the repository at this point in the history

  15. * Add "Managing packages" page. 

    * Stop using autosectionlabel. It's just too complicated and not lexible enough.

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    904fbad View commit details
    Browse the repository at this point in the history

  16. Cleanup warnings in rst files 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    2af4b9c View commit details
    Browse the repository at this point in the history

  17. Try without "currentmodule". Maybe it will improve the search experie… 

    …nce on RTD...

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    401779e View commit details
    Browse the repository at this point in the history

  18. Remove sphinx workflow 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    ddf9d49 View commit details
    Browse the repository at this point in the history

  19. Convert rez-pip documentation 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    485a57c View commit details
    Browse the repository at this point in the history

  20. Attempt at improving images for dark theme users by using a custom CS… 

    …S class

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    116c47d View commit details
    Browse the repository at this point in the history

  21. Simplify Sphinx cache management 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    5899d7a View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2023

  1. Support OS driven dark mode 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Aug 31, 2023
    Configuration menu
    Copy the full SHA
    3b11862 View commit details
    Browse the repository at this point in the history

Commits on Sep 2, 2023

  1. Auto-generate the commands documentation 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 2, 2023
    Configuration menu
    Copy the full SHA
    17510be View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2023

  1. Reference commands and options in the docs 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 3, 2023
    Configuration menu
    Copy the full SHA
    1a46faa View commit details
    Browse the repository at this point in the history

  2. Fix top level links 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 3, 2023
    Configuration menu
    Copy the full SHA
    5dbd3ab View commit details
    Browse the repository at this point in the history

  3. Fix leftover markdown hyperlink 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 3, 2023
    Configuration menu
    Copy the full SHA
    e40c02d View commit details
    Browse the repository at this point in the history

  4. Cross reference rez commands in the rez config section 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 3, 2023
    Configuration menu
    Copy the full SHA
    ee8f4ed View commit details
    Browse the repository at this point in the history

Commits on Sep 4, 2023

  1. Fix typo (#1) 

    Co-authored-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: David Lai <[email protected]>
    @davidlatwe @JeanChristopheMorinPerso
    davidlatwe and JeanChristopheMorinPerso committed Sep 4, 2023
    Configuration menu
    Copy the full SHA
    3b2848a View commit details
    Browse the repository at this point in the history

  2. Fix bad link in installation.rst 

    Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 4, 2023
    Configuration menu
    Copy the full SHA
    3321226 View commit details
    Browse the repository at this point in the history

  3. Use horizontal logo with name in logo and remove title in sidebar. Th… 

    …is will give more vertical space to the content in the sidebar.

Signed-off-by: Jean-Christophe Morin <[email protected]>
    @JeanChristopheMorinPerso
    JeanChristopheMorinPerso committed Sep 4, 2023
    Configuration menu
    Copy the full SHA
    5175fb2 View commit details
    Browse the repository at this point in the history