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.

Sign up for GitHub

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

Jump to bottom

Add User Guide to docs #8

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

Add User Guide to docs #8

wants to merge 4 commits into from

Conversation

pressler-vsc
Copy link
Contributor

Description

This PR adds a "User Guide" to the SARkit docs.

The proposed documentation from this branch is currently hidden but available at:

https://sarkit.readthedocs.io/en/user-guide/user_guide.html

Notes

  • modified .gitlab-ci.yml to store docs artifacts (only used upstream)
  • replaced SARPy logo with interim SARkit
  • add doctest run to noxfile.py to get some level of checking on the code snippets in the docs
  • added some project.urls to the pyproject.toml

johnstob
johnstob approved these changes Jan 7, 2025
View reviewed changes
Copy link
Contributor

@johnstob johnstob left a comment

Choose a reason for hiding this comment

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

Matches up with internally reviewed changes. Nice work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnstob johnstob johnstob approved these changes

@bombaci-vsc bombaci-vsc bombaci-vsc approved these changes

@mtrachy mtrachy Awaiting requested review from mtrachy

@dhaverporth dhaverporth Awaiting requested review from dhaverporth

@mstewart-vsc mstewart-vsc Awaiting requested review from mstewart-vsc

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pressler-vsc @bombaci-vsc @johnstob