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

#6: Add documentation #8

Merged
merged 9 commits into from
Oct 31, 2024
Merged

#6: Add documentation #8

merged 9 commits into from
Oct 31, 2024

Conversation

cwschilly
Copy link
Collaborator

@cwschilly cwschilly commented Oct 24, 2024 •
edited
Loading

Fixes #6

Build and view the docs locally with:

cd <pressio-ops>/docs
pip install -r build_requirements.txt
make html
firefox generated_docs/index.html

@cwschilly cwschilly linked an issue Oct 24, 2024 that may be closed by this pull request
brainstorm best way to document what this library offers #6
Closed
@cwschilly cwschilly marked this pull request as draft October 24, 2024 15:48
@cwschilly cwschilly self-assigned this Oct 24, 2024
@fnrizzi
Copy link
Member

fnrizzi commented Oct 27, 2024

generated_docs should be ignored by git

@cwschilly cwschilly marked this pull request as ready for review October 29, 2024 14:28
@cwschilly cwschilly requested a review from fnrizzi October 29, 2024 14:29
@fnrizzi fnrizzi merged commit 6baf0e9 into develop Oct 31, 2024
21 checks passed
@fnrizzi fnrizzi deleted the 6-brainstorm-best-way-to-document-what-this-library-offers branch November 10, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fnrizzi fnrizzi Awaiting requested review from fnrizzi

Assignees

@cwschilly cwschilly

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

brainstorm best way to document what this library offers
2 participants
@cwschilly @fnrizzi