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

docs: sphinx reference doc index generation #853

Merged
merged 2 commits into from
Nov 16, 2023
Merged

docs: sphinx reference doc index generation #853

merged 2 commits into from
Nov 16, 2023

Commits on Nov 16, 2023

  1. Run a pre-hook to create index file in policy reference 

    To be able to list the whole policy reference definition, we needs index
file for each category.
Create them on the fly, listing the reference policies generated in the
reference destination directory, before generating the finale
documentation.

Co-authored-by: Jean-Baptiste Lallement <jean-baptiste@ubuntu.com>
    @didrocks @jibel
    didrocks and jibel committed Nov 16, 2023
    Configuration menu
    Copy the full SHA
    00c1e31 View commit details
    Browse the repository at this point in the history

  2. Avoid an inifinite refresh loop when saving the documentation 

    With make run, listening to any file changes in the destination
directory, the script generating the index files will rerun everytime,
creating a new event, rerunning the generation and so on.
Exclude then any index files under those known subdirectories.
    @didrocks
    didrocks committed Nov 16, 2023
    Configuration menu
    Copy the full SHA
    88103ff View commit details
    Browse the repository at this point in the history