You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To date, documentation published on https://populse.github.io/populse_db is located in the docs directory of master branch. This is a mess with git when one wants to modify some sources but not yet the published html. If the doc generation was tested locally (with make html), a lot of files get modified and it is difficult to tell the few ones that are modified sources from the modifications done by sphinx generator.
I propose to remove the Sphinx generated files from master branch (keeping only source files) and to keep them in a dedicated published_documentation branch that would be used by https://populse.github.io/populse_db. Modification of the documentation source would be simpler and publication of a new version of the documentation would require to start with the following commands:
git checkout published_documentation
git pull
git merge master
# create doc, commit and push as before
The text was updated successfully, but these errors were encountered:
It's possible and probably better to setup an automatic docs building in the gh-pages branch, but it needs either a working travis-ci or a github action.
To date, documentation published on https://populse.github.io/populse_db is located in the
docs
directory ofmaster
branch. This is a mess withgit
when one wants to modify some sources but not yet the published html. If the doc generation was tested locally (withmake html
), a lot of files get modified and it is difficult to tell the few ones that are modified sources from the modifications done by sphinx generator.I propose to remove the Sphinx generated files from
master
branch (keeping only source files) and to keep them in a dedicatedpublished_documentation
branch that would be used by https://populse.github.io/populse_db. Modification of the documentation source would be simpler and publication of a new version of the documentation would require to start with the following commands:The text was updated successfully, but these errors were encountered: