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

Generate Sphinx docs #11

Open
maedoc opened this issue Feb 9, 2023 · 7 comments
Open

Generate Sphinx docs #11

maedoc opened this issue Feb 9, 2023 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@maedoc
Copy link
Member

maedoc commented Feb 9, 2023

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

@Ziaeemehr
Copy link
Collaborator

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
Copy link
Collaborator

  • add hyperlink to the functions in documentation
  • add [source] also to show the source code inline.

@Ziaeemehr
Copy link
Collaborator

Ziaeemehr commented Dec 5, 2023

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

  • One solution is to make html file and then manually move the content of build directory into docs. Messy but works.
  • The other solution is adding .github/workflows/gh_pages.yml but needs to be edited.

@Ziaeemehr
Copy link
Collaborator

@Ziaeemehr
Copy link
Collaborator

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
Copy link
Collaborator

@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
Copy link
Collaborator

Ziaeemehr commented Dec 10, 2023

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants