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

Prelim docs #74

Merged
merged 2 commits into from
Oct 6, 2023
Merged

Prelim docs #74

merged 2 commits into from
Oct 6, 2023

Conversation

rebeccabilbro
Copy link
Member

This PR fixes sc-20959 which requested some preliminary PyEnsign docs that we could host on read the docs and link to from the ensign docs. This should also make it easier for PyEnsign contributors to contribute to the PyEnsign docs!

I have made the following changes:

  1. Set up a new sphinx project inside the docs/ folder
  2. Added some preliminary content, but mainly just to show how we can integrate our own text with the PyEnsign code using the autodoc feature in Sphinx.

Questions for the @pdeziel

  • Anything else you think we should include?

CHECKLIST

  • Is the commit message formatted correctly?
  • Do all of your functions and methods have docstrings?
  • Have you added/updated unit tests where appropriate?
  • Have you run the unit tests using pytest?
  • Is your code style correct (are you using PEP8, pyflakes)?

@shortcut-integration
Copy link

This pull request has been linked to Shortcut Story #20959: Create prelim RTD docs for PyEnsign.

Copy link
Collaborator

@pdeziel pdeziel left a comment

Choose a reason for hiding this comment

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

Looks good, can't wait to see how this looks!

@pdeziel pdeziel merged commit 20e86f2 into develop Oct 6, 2023
4 checks passed
@pdeziel pdeziel deleted the sc-20959 branch October 6, 2023 22:34
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