diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ac182b844..9de9e8c54 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,7 +6,7 @@ Overview Each tutorial is a `Jupyter notebook `_ file. Each notebook is saved in a separate directory within the ``tutorials/notebooks`` subdirectory in this project. For an example, let's look at the source notebook -of the `FITS-header `_ tutorial. Within ``tutorials/notebooks/FITS-header``, there is a single Jupyter notebook file that contains the text and code for the tutorial, and any small data files used @@ -188,7 +188,7 @@ your ``requirements.txt`` file would look like: numpy>=1.13 To see an example, have a look at the FITS-header `requirements.txt file `_. Push the notebook and other files from your local branch up to your fork of the @@ -244,7 +244,7 @@ procedure: If you do this, the only change necessary when merging your notebook will be to set ``tutorialpath`` to ``'http://data.astropy.org/tutorials/My-tutorial-name/'``. -For larger data files that are bigger than 10 MB in size, we recommend hosting with Zenodo. +For larger data files that are bigger than 10 MB in size, we recommend hosting with Zenodo. To use this approach, follow these steps: * You will need to sign up for an account with Zenodo before you can upload a file there. diff --git a/README.rst b/README.rst index 66c2ec39a..07b61552e 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ You can also get started quickly using `Binder `_ to run th your web browser within a remote server: .. image:: http://mybinder.org/badge.svg - :target: https://mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=tutorials/notebooks + :target: https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials/notebooks Contributing tutorial material diff --git a/scripts/tests/test_convert.py b/scripts/tests/test_convert.py index b709a0f47..634b54ede 100644 --- a/scripts/tests/test_convert.py +++ b/scripts/tests/test_convert.py @@ -10,7 +10,7 @@ tests_path = path.split(path.abspath(__file__))[0] def test_convert_succeed(): - # With the current master version of nbconvert, we can allow errors + # With the current main version of nbconvert, we can allow errors # per-cell. This notebook, even though it raises an exception, should still # execute fine: nbc = NBConverter(path.join(tests_path, 'test-succeed.ipynb')) diff --git a/tutorials/astropy.tpl b/tutorials/astropy.tpl index 5ddb31cc0..09393fb0d 100644 --- a/tutorials/astropy.tpl +++ b/tutorials/astropy.tpl @@ -8,7 +8,7 @@ .. raw:: html - +
@@ -31,7 +31,7 @@
- + {% endblock %} diff --git a/tutorials/dev.rst b/tutorials/dev.rst index 1a6c3cd72..ad27c3451 100644 --- a/tutorials/dev.rst +++ b/tutorials/dev.rst @@ -8,7 +8,7 @@ Documentation on tutorials infrastructure Overview -------- -Tutorials are written as Jupyter notebooks on the ``master`` branch of the +Tutorials are written as Jupyter notebooks on the ``main`` branch of the ``astropy/astropy-tutorials`` repository in ``tutorials/notebooks/``. These notebook files do not contain output in order to simplify version-controlling the files. @@ -22,7 +22,7 @@ We use `CircleCI `_ to do the Sphinx build, which is then pushed to the ``gh-pages`` branch of the repository and served by GitHub. The notebooks are first converted to RST files during the Sphinx build by doing the conversion at the end of the `Sphinx configuration file -`_. +`_. Why not use nbsphinx? --------------------- @@ -73,7 +73,7 @@ Building the tutorials page locally ----------------------------------- For this, you can use the `Makefile -`_ at the +`_ at the top-level of the tutorials repository. From the root level of the cloned or downloaded repository:: @@ -131,7 +131,7 @@ Marking a cell with an intentional error Edit the cell metadata of the cell in which you would like to raise an exception and add the following to the top-level JSON: ``"tags": ["raises-exception"]`` -This tag is recognized by the latest (master) version of nbconvert. +This tag is recognized by the latest (main) version of nbconvert. Automatically Strip Output and Notebook Metadata ------------------------------------------------