issues
search
jupyterhub
/
nbgitpuller
Jupyter server extension to sync a git repository one-way to a local path
https://nbgitpuller.readthedocs.io
BSD 3-Clause "New" or "Revised" License
210
stars
86
forks
source link
A refresher of the documentation system
#251
Open
consideRatio
opened
2 years ago
consideRatio
commented
2 years ago
Transition to 100% MyST
Cleanup the sphinx
conf.py
file
Reduced complexity by stripping LaTeX/PDF/HTMLHelp build configurations
Remove other configurations that aren't used but just part of a boilerplate, for example some version specification hardcoded in
conf.py
Example configurations:
z2jh
Update our Makefile commands to include
make devenv
- a command to start up an automatically refreshing-on-changes kind of local webserver
make linkcheck
- a command to check links being valid
Example configurations:
z2jh
Add relevant GitHub CI integration:
Run
make linkcheck
Example configurations:
z2jh
Add relevant
pre-commit-config
prettier
for markdown formatting (and formatting of embedded Python code block)
Example configurations:
z2jh
conf.pyfileconf.pymake devenv- a command to start up an automatically refreshing-on-changes kind of local webservermake linkcheck- a command to check links being validmake linkcheckpre-commit-configprettierfor markdown formatting (and formatting of embedded Python code block)