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

Update the RST docs #378

Merged
merged 33 commits into from
Jul 20, 2023
Merged

Update the RST docs #378

merged 33 commits into from
Jul 20, 2023

Conversation

cwwalter
Copy link
Member

Upates to the documentation.

Make a working exanmple to test installation in the examples sub-directory
and add a section to the installation instruction about how to test the
install.
Add new sections for the config system and using using imSim.
Re-title some sections and re-order them in the overall TOC.
The end of the image section doc strings.
Complete config section.
Also remove accidentally committed file.
It fills me with rage I had to do this.
@cwwalter cwwalter added this to the imSim 2.0 milestone Jul 19, 2023
@cwwalter cwwalter self-assigned this Jul 19, 2023
@cwwalter cwwalter changed the title Updates the RST docs Update the RST docs Jul 19, 2023
@cwwalter cwwalter temporarily deployed to github-pages July 20, 2023 02:59 — with GitHub Actions Inactive
Put guidance and ideas in for:

data-formats.rst
lsst-camera.rst
lsst-optical.rst
module-use.rst

including adding an image of the camera focal plane.
@cwwalter cwwalter temporarily deployed to github-pages July 20, 2023 03:23 — with GitHub Actions Inactive
@cwwalter cwwalter merged commit b8ed176 into main Jul 20, 2023
@cwwalter cwwalter deleted the u/cwalter/config-docs branch July 20, 2023 23:32
@rmjarvis
Copy link
Contributor

Ugh. Chris, I'm still reviewing this!

@rmjarvis rmjarvis restored the u/cwalter/config-docs branch July 20, 2023 23:57
@cwwalter
Copy link
Member Author

Ugh. Sorry!

I didn't actually know you were doing a review.

Please leave comments here and I will apply them in a new branch since this is already merged (I guess that is the best way).

Copy link
Contributor

@rmjarvis rmjarvis left a comment

Choose a reason for hiding this comment

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

Thanks Chris. I have some comments and corrections. I tried to make inline suggested changes when I thought they were straightforward. If you're happy with them, you can accept them on Github (preferably grouping many of them in a batch commit probably). Places where I had a less specific change are just normal comments.

doc/config.rst Show resolved Hide resolved
doc/config.rst Show resolved Hide resolved
doc/config.rst Show resolved Hide resolved
doc/config.rst Show resolved Hide resolved
doc/config.rst Show resolved Hide resolved
doc/config.rst Show resolved Hide resolved
doc/config.rst Show resolved Hide resolved
doc/usage.rst Show resolved Hide resolved
doc/usage.rst Show resolved Hide resolved
examples/imsim-user.yaml Show resolved Hide resolved
@rmjarvis
Copy link
Contributor

Oh well. It seems like you won't be able to apply the commits directly, since the PR is closed. That will make this a bit more annoying for you... :(

@rmjarvis
Copy link
Contributor

@cwwalter
Copy link
Member Author

Thank you!

I'm just super glad it didn't wipe out what you had already started typing.

@cwwalter
Copy link
Member Author

Thanks Mike!

Because this PR is already merged and such a mess I couldn't just accept things, I did it all manually (sorry for the email barrage). I will actually check in these changes into a new PR.

@cwwalter cwwalter deleted the u/cwalter/config-docs branch September 20, 2023 18:50
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