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

Add documentation builds #13

Merged
merged 4 commits into from
May 12, 2024
Merged

Add documentation builds #13

merged 4 commits into from
May 12, 2024

Conversation

michaelosthege
Copy link
Member

Branch originates from the #12 branch. Please review & merge that one first.

  • Moves notebooks to /docs/sources/notebooks because including them from a directory outside docs/sources is f**** difficult.
  • Added ReadTheDocs configuration
  • Modified headline levels in notebooks to look pretty in the docs.

@michaelosthege michaelosthege added documentation Improvements or additions to documentation enhancement New feature or request labels May 11, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@michaelosthege michaelosthege force-pushed the add-docs branch 3 times, most recently from bee9b4f to af708f0 Compare May 11, 2024 13:42
docs/source/pp_plots.rst Outdated Show resolved Hide resolved
peak_performance/models.py Show resolved Hide resolved
@michaelosthege michaelosthege marked this pull request as ready for review May 11, 2024 22:44
@michaelosthege
Copy link
Member Author

Party's got busted by damn whitespace again 😑

Goin to rebase real quick to make things right.

michaelosthege and others added 4 commits May 12, 2024 00:53
Makes it easier to embed them in the documentation.
ReadTheDocs config needs to refer to the `requirements.txt` file.
Co-authored-by: Jochen Nießer <[email protected]>
@Y0dler Y0dler merged commit 893d24d into main May 12, 2024
5 checks passed
@Y0dler Y0dler deleted the add-docs branch May 12, 2024 11:52
@github-actions github-actions bot locked and limited conversation to collaborators May 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants