search

RatInABox-Lab / RatInABox

A python package for simulating 2D motion in continuous environment and spatial cell types (e.g. place cell).
MIT License
184 stars 31 forks source link

Add Sphinx-based website #87

Closed adamltyson closed 11 months ago

adamltyson commented 11 months ago

This PR adds a simple website using the PyData Sphinx Theme generated from the NIU Python cookiecutter template.

To give an idea of a future website structure, I've copied the README information along with the mission statement. I've restructured this a bit, mostly to give a sense of what the final website could look like. Some of the links may be a bit brittle (I did a find and replace for local links). Eventually all the gifs etc should probably be in docs/source/_static or equivalent.

All files are in docs/ and there is a README.md with some information, but to render locally, you only need to install the dependencies (pip install -r docs/requirements.txt) and build the docs sphinx-build docs/source docs/build). To view, open docs/build/index.html in a browser.

This PR also includes a GitHub action that will build the docs into a seperate branch (gh-pages) whenever a tag is released. Enabling GitHub pages in settings will host this website at https://ratinabox-lab.github.io/ratinabox.

TomGeorge1234 commented 11 months ago

Thanks for this Adam - it looks really great.

Yeah as you say in the long run this is going to become incompatible with the current SOA whereby all docs are hosted on the GitHub README but I'm happy to start here for now and cross that bridge down the line