BlueBrain / nmodl

Code Generation Framework For NEURON MODeling Language
https://bluebrain.github.io/nmodl/
Apache License 2.0
49 stars 15 forks source link

Publishing temporary docs on PR #1186

Open JCGoran opened 4 months ago

JCGoran commented 4 months ago

Sometimes we may want to be able to check that the docs build and render properly before merging a PR to master. While we do build the docs on PRs, we do not publish them somewhere for viewing, so it's not obvious if there are rendering issues in the docs of a given PR. A possible implementation would be something like what they do at sage math, where, at each PR, temporary documentation is built (we already have that), and then a GH bot posts a comment about it (see here and here for the CI), as shown for instance here.