Skip to content

Add documentation #7

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

Merged
janbridley merged 25 commits into from
Apr 8, 2024
Merged

Add documentation #7

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
fc23a21
Run sphinx-quickstart
janbridley Apr 5, 2024
92f7243
Move doc source to doc/source
janbridley Apr 5, 2024
4aa9492
Add doc/requirements.txt
janbridley Apr 5, 2024
a882ef2
Replace README.md with README.rst and add basic docs
janbridley Apr 7, 2024
47a1e45
Add block M
janbridley Apr 7, 2024
dbb49e8
Add header images and update index.rst
janbridley Apr 7, 2024
8d108e8
Update conf.py
janbridley Apr 7, 2024
40f5e06
Correct page template
janbridley Apr 7, 2024
dc32a17
Update README.rst
janbridley Apr 7, 2024
500ac22
Fix literalinclude in README.rst
janbridley Apr 7, 2024
94c2025
Update README.rst
janbridley Apr 7, 2024
f799d5b
Add autodocsumm doc/requirements.txt
janbridley Apr 7, 2024
b7d5b86
Add datetime autoupdate to docs copyright
janbridley Apr 7, 2024
e24f1a3
Match docs style to HOOMD-Blue
janbridley Apr 7, 2024
f927b6f
Update version in pyproject.toml
janbridley Apr 7, 2024
fdddabe
Updates to toctree
janbridley Apr 7, 2024
52c66af
Update development.rst
janbridley Apr 7, 2024
53e2222
Update changelog and credits
janbridley Apr 7, 2024
933ccaf
Remove incorrect makefile
janbridley Apr 7, 2024
5a7fa89
Fix changelog.rst
janbridley Apr 7, 2024
0b96c54
Add favicon to docs
janbridley Apr 7, 2024
348bcf8
Add instructions for building docs
janbridley Apr 8, 2024
76fa633
Update keepachangelog version
janbridley Apr 8, 2024
39a9bd0
Update links to parsnip-cif
janbridley Apr 8, 2024
f596623
Clarify dependencies in README.rst
janbridley Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add header images and update index.rst
  • Loading branch information
@janbridley
janbridley committed Apr 7, 2024
commit dbb49e86151a5363078cfa8cd102c32d07b451e3
37 changes: 37 additions & 0 deletions doc/source/_static/parsnip_header_dark.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions doc/source/_static/parsnip_header_light.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 1 addition & 7 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
.. parsnip documentation master file, created by
sphinx-quickstart on Fri Apr 5 14:52:12 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to parsnip's documentation!
===================================
.. include:: ../../README.rst

.. toctree::
:maxdepth: 2
Expand Down