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

Add header information to docs #138

Merged
merged 4 commits into from
Jan 16, 2024
Merged

Conversation

pgriffin17
Copy link
Collaborator

This PR adds a Header page to the User Guide page on the documentation site showing auto-generated header information based on the _info properties in the Observatory class. More updates should be done to this page in the future, but for now, a summary of the features follows:

  • Created headerCSVGenerator.py script that generates a CSV file from the _info properties of the Observatory class.
  • Updated info dictionaries within _info properties of Observatory to allow for simpler parsing by the CSV generator.
  • Added import to conf.py in sphinx source directory so that the CSV file is generated automatically and embedded on the documentation website.

@WWGolay
Copy link
Collaborator

WWGolay commented Jan 16, 2024

@pgriffin17 is this PR ready?

@pgriffin17
Copy link
Collaborator Author

Yes, should be good to go.

@WWGolay WWGolay merged commit eab4117 into macro-consortium:main Jan 16, 2024
4 checks passed
@pgriffin17 pgriffin17 deleted the headerInfo branch February 10, 2024 03:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants