ins-amu / vbjax

A nascent Jax-based package for virtual brain modeling.
Apache License 2.0
6 stars 2 forks source link

Generate Sphinx docs #11

Open maedoc opened 1 year ago

maedoc commented 1 year ago

Setting up Sphinx documentation would be better long run than a pile of notebooks. We can get started with just running autodocs.

Ziaeemehr commented 7 months ago

adding sample documents into the example script, like this : https://github.com/Ziaeemehr/JITCSIM/blob/master/jitcsim/examples/scripts/examples_kuramoto/00_ode_kuramoto_II.py

Ziaeemehr commented 7 months ago
Ziaeemehr commented 7 months ago

the issue for page is that github look into ./docs for index.html

Ziaeemehr commented 7 months ago

https://ins-amu.github.io/vbjax/

Ziaeemehr commented 7 months ago

I used this as a pattern for documentation. I am still have issue to make github run makefile to produce html files (unless I upload html file which doesn't seems neat solution).

Ziaeemehr commented 7 months ago

@maedoc to generate page from readthedocs just need to have "required permission" to the repo, sign up for an account, and import the repository. The yml file is already in the repo.

Ziaeemehr commented 7 months ago

seems working: https://vbjax.readthedocs.io/en/latest/#

with some error on the dashboard: Webhook activation failed. Make sure you have the necessary permissions.