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

Improve linkage of CMake documentation #2355

Merged
merged 11 commits into from Nov 9, 2023

Conversation

thomas-bc
Copy link
Collaborator

@thomas-bc thomas-bc commented Nov 2, 2023

Originating Project/Creator
Affected Component docs
Affected Architectures(s)
Related Issue(s) #1912
Has Unit Tests (y/n)
Builds Without Errors (y/n)
Unit Tests Pass (y/n)
Documentation Included (y/n)

Change Description

Fixes #1912

Rationale

Better linkage of the exhaustive CMake docs we have. Also fixing some out-of-date stuff

@thomas-bc thomas-bc changed the title Add TOC generation to cmake docs Improve linkage of CMake documentation Nov 2, 2023
cmake/docs/docs.py Outdated Show resolved Hide resolved
@thomas-bc thomas-bc marked this pull request as draft November 2, 2023 23:35
@thomas-bc thomas-bc marked this pull request as ready for review November 7, 2023 18:34
@thomas-bc thomas-bc added the Documentation Documentation, Tutorials and References updates label Nov 7, 2023
@thomas-bc
Copy link
Collaborator Author

I have made some additional changes to improve linkage of documentation overall.

  • added index_gen.py: takes as input a directory and outputs an index of all the markdown files nested within
  • using that to generate the CMake index
  • added a run of that script at the top level of the documentation -> generates a full index of the entire documentation. Maybe it could be linked at the bottom of the side-bar table of contents?

@LeStarch
Copy link
Collaborator

LeStarch commented Nov 9, 2023

Ready for merge when you are!

@thomas-bc thomas-bc merged commit 1e8d413 into nasa:devel Nov 9, 2023
34 checks passed
@thomas-bc thomas-bc deleted the cmake-docs-linking branch November 9, 2023 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation, Tutorials and References updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CMAKE variable list to F Prime docs
2 participants