WIP: Documentation with continuous integration

perrin-isir / xpag

a modular reinforcement learning library with JAX agents

BSD 3-Clause "New" or "Revised" License

22 stars 5 forks source link

WIP: Documentation with continuous integration #7

Closed stephane-caron closed 1 year ago

stephane-caron commented 1 year ago

Starting as a draft PR so that you can chime in as it evolves. So far the documentation can be built locally by:

sphinx-build doc _build

Then you can check it out by e.g. firefox _build/index.html.

We can organize the documentation later on (e.g. it is a great place to go in more details than the README). For starters this branch tries out a Sphinx module to automatically generate the API documentation. It should look like this:

stephane-caron commented 1 year ago

Just to share a sense of where this is going, roughly the next steps are:

[ ] @stephane-caron : Check with @perrin-isir that this is a good first step
[ ] @stephane-caron : Add a GitHub workflow that builds the doc and pushes to gh-pages
[ ] @perrin-isir : Merge this PR
[ ] @perrin-isir : Configure GitHub Pages in the repository
- Go to Settings → Pages, in "Build and deployment" set "Source" to "Deploy from a branch" and "Branch" to gh-pages
[ ] ... (placeholder for all things not anticipated) ...
[ ] Both: enjoy docs at https://perrin-isir.github.io/xpag/ :books:

perrin-isir commented 1 year ago

Thanks! I merged and added the workflow to push to https://perrin-isir.github.io/xpag/

Now what remains to be done is the actual documentation of classes and functions :)....