Skip to content

Commit 9f6930e

Browse files
committed
master->main in README and docs
1 parent 39b6e66 commit 9f6930e

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Build Status](https://travis-ci.com/python-hydro/pyro2.svg?branch=master)](https://travis-ci.com/python-hydro/pyro2) [![Documentation Status](https://readthedocs.org/projects/pyro2/badge/?version=latest)](https://pyro2.readthedocs.io/en/latest/?badge=latest) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/python-hydro/pyro2/master?filepath=examples%2Fexamples.ipynb) [![JOSS status](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7/status.svg)](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7) [![DOI](https://zenodo.org/badge/20570861.svg)](https://zenodo.org/badge/latestdoi/20570861)
1+
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Build Status](https://travis-ci.com/python-hydro/pyro2.svg?branch=main)](https://travis-ci.com/python-hydro/pyro2) [![Documentation Status](https://readthedocs.org/projects/pyro2/badge/?version=latest)](https://pyro2.readthedocs.io/en/latest/?badge=latest) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/python-hydro/pyro2/main?filepath=examples%2Fexamples.ipynb) [![JOSS status](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7/status.svg)](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7) [![DOI](https://zenodo.org/badge/20570861.svg)](https://zenodo.org/badge/latestdoi/20570861)
22

33

44

@@ -92,12 +92,12 @@ https://pyro2.readthedocs.io/
9292
The main data structures that describe the grid and the data the lives
9393
on the grid are described in a jupyter notebook:
9494

95-
https://github.com/python-hydro/pyro2/blob/master/mesh/mesh-examples.ipynb
95+
https://github.com/python-hydro/pyro2/blob/main/mesh/mesh-examples.ipynb
9696

9797
Many of the methods here rely on multigrid. The multigrid solver is
9898
demonstrated in the juputer notebook:
9999

100-
https://github.com/python-hydro/pyro2/blob/master/multigrid/multigrid-examples.ipynb
100+
https://github.com/python-hydro/pyro2/blob/main/multigrid/multigrid-examples.ipynb
101101

102102

103103
## Solvers

docs/source/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@
5757
# see https://github.com/phn/pytpm/issues/3#issuecomment-12133978
5858
numpydoc_show_class_members = False
5959

60-
# The master toctree document.
61-
master_doc = 'index'
60+
# The main toctree document.
61+
main_doc = 'index'
6262

6363
# General information about the project.
6464
project = 'pyro'
@@ -161,7 +161,7 @@
161161
# (source start file, target name, title,
162162
# author, documentclass [howto, manual, or own class]).
163163
latex_documents = [
164-
(master_doc, 'pyro.tex', 'pyro Documentation',
164+
(main_doc, 'pyro.tex', 'pyro Documentation',
165165
'pyro development team', 'manual'),
166166
]
167167

@@ -171,7 +171,7 @@
171171
# One entry per manual page. List of tuples
172172
# (source start file, name, description, authors, manual section).
173173
man_pages = [
174-
(master_doc, 'pyro', 'pyro Documentation',
174+
(main_doc, 'pyro', 'pyro Documentation',
175175
[author], 1)
176176
]
177177

@@ -182,7 +182,7 @@
182182
# (source start file, target name, title, author,
183183
# dir menu entry, description, category)
184184
texinfo_documents = [
185-
(master_doc, 'pyro', 'pyro Documentation',
185+
(main_doc, 'pyro', 'pyro Documentation',
186186
author, 'pyro', 'One line description of project.',
187187
'Miscellaneous'),
188188
]

docs/source/help.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Pull Requests
2929

3030
*Any contributions that have the potential to change answers should be
3131
done via pull requests.* A pull request should be generated from your
32-
fork of pyro and target the `master` branch.
32+
fork of pyro and target the `main` branch.
3333

3434
The unit and regression tests will run automatically once the PR is
3535
submitted, and then one of the pyro developers will review the PR and

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. pyro documentation master file, created by
1+
.. pyro documentation main file, created by
22
sphinx-quickstart on Mon Dec 25 18:42:54 2017.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.

0 commit comments

Comments
 (0)