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

Updating documentation for various elements #476

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

antonhibl
Copy link
Contributor

@antonhibl antonhibl commented Feb 14, 2024

Addressing #453. This PR primarily adds documentation updates to affect the sphynx docs; currently further updates and documents code methods and parameters in the following areas(this list will be updated with checks as I go through the various parts of the codebase):

Library

  • USGSCSM Distortion Class
  • USGSCSM Utilities Class
  • USGSCSM Astro Plugin Class
  • USGSCSM Astro Frame Sensor Model Class
  • USGSCSM Linescan Sensor Model Class
  • USGSCSM SAR Sensor Model Class

Cameras

  • All camera examples updated and rendering

Creating an Environment

  • Install instructions shifted to the top and updated to fix all rendering.
  • If installation with pip is supported add that.

Fixing Typos or Incorrect Links

Addressing and fixing various incorrect links and typos as I go through the code. So far I have found:

  • Fixed broken links in source/docs/index.rst (USGS-Astrogoelogy -> DOI-USGS)

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

@antonhibl antonhibl self-assigned this Feb 14, 2024
@antonhibl antonhibl added the documentation issue with broken links, typos, grammar, unclear descriptions, etc. found in the documentation label Feb 14, 2024
@antonhibl antonhibl linked an issue Feb 14, 2024 that may be closed by this pull request
9 tasks
Copy link
Collaborator

@Kelvinrr Kelvinrr left a comment

Choose a reason for hiding this comment

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

Great job with the docs, just some things inline.

docs/source/user/creating_an_environment.rst Outdated Show resolved Hide resolved
src/UsgsAstroFrameSensorModel.cpp Outdated Show resolved Hide resolved
@antonhibl antonhibl requested a review from Kelvinrr May 2, 2024 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issue with broken links, typos, grammar, unclear descriptions, etc. found in the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update doc strings
2 participants