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

Fix example docs and background width #173

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

e10harvey
Copy link
Collaborator

@e10harvey e10harvey commented Oct 9, 2024

Purpose

Fix the formatting of our readthedocs documentation. E.g., see https://opencsp.readthedocs.io/en/main/example/scene_reconstruction/config.html.

Summary of changes

Add css style to expand width of white background to entire screen.
Fix doc-string format such that lists include newlines between elements.

Implementation notes

Checked via ./make_docs.sh && open html/index.html

Submission checklist

  • Target branch is develop, not main
  • Existing tests are updated or new tests were added
  • opencsp/test/test_DocStringsExist.py are verified to include this change or have been updated accordingly
  • .rst file(s) under doc/ are verified to include this change or have been updated accordingly

Additional information

Please provide any additional information here.

Copy link
Collaborator

@braden6521 braden6521 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@e10harvey, this all looks good to me!

@e10harvey e10harvey merged commit b6d0d3e into sandialabs:develop Oct 31, 2024
4 checks passed
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