search

jupyter / nbclassic

Jupyter Notebook as a Jupyter Server extension
https://nbclassic.readthedocs.io/en/latest
BSD 3-Clause "New" or "Revised" License
73 stars 63 forks source link

Adding a webhook to build docs automatically with new commits #151

Closed RRosio closed 1 year ago

RRosio commented 2 years ago

With the nbclassic readthedocs documentation up, a nice feature to make use of is to add a webhook to allow the documentation to build automatically. We can also add a badge to show the status of the docs in the Readme file for visibility.

echarles commented 1 year ago

@RRosio I think you said that the hook was enabled, but don't have the details. Is the website built on each merged PR?

For the badges, https://github.com/jupyter/notebook has a bunch of those, including the docs.

Screenshot 2022-10-10 at 09 41 27

The code for that is 


![Github Actions Status](https://github.com/jupyter/notebook/workflows/Build/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/notebook/main?urlpath=tree)
[![codecov](https://codecov.io/gh/jupyter/notebook/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyter/notebook)
RRosio commented 1 year ago

@echarles Yes I believe that with each PR merged to the main branch the docs are built. Thank you for the code samples I will work on adding them in a new PR!

RRosio commented 1 year ago

Badge was added by #160 so I will close this issue as it's complete at this time.