diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7b26137..eb97c56 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,7 +2,7 @@ name: continuous-integration on: push: - branches: [master] + branches: [main] pull_request: jobs: diff --git a/README.md b/README.md index 9c2a0ed..b579f08 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ **A proof extension for Sphinx**. -This package contains a [Sphinx](http://www.sphinx-doc.org/en/master/) extension +This package contains a [Sphinx](http://www.sphinx-doc.org/) extension for producing proof, theorem, axiom, lemma, definition, criterion, remark, conjecture, corollary, algorithm, example, property, observation, proposition and assumption directives. @@ -40,7 +40,7 @@ We welcome all contributions! See the [EBP Contributing Guide](https://executabl [rtd-badge]: https://readthedocs.org/projects/sphinx-proof/badge/?version=latest [rtd-link]: https://sphinx-proof.readthedocs.io/en/latest/?badge=latest -[github-ci]: https://github.com/executablebooks/sphinx-proof/workflows/continuous-integration/badge.svg?branch=master +[github-ci]: https://github.com/executablebooks/sphinx-proof/workflows/continuous-integration/badge.svg?branch=main [github-link]: https://github.com/executablebooks/sphinx-proof -[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-proof/branch/master/graph/badge.svg +[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-proof/branch/main/graph/badge.svg [codecov-link]: https://codecov.io/gh/executablebooks/sphinx-proof diff --git a/docs/source/index.md b/docs/source/index.md index 21ebe67..74dff27 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -15,7 +15,7 @@ zreferences **A proof extension for Sphinx**. -This package contains a [Sphinx](http://www.sphinx-doc.org/en/master/) extension +This package contains a [Sphinx](http://www.sphinx-doc.org/) extension for producing proof, theorem, axiom, lemma, definition, criterion, remark, conjecture, corollary, algorithm, example, property, observation, proposition and assumption directives. @@ -61,7 +61,7 @@ you may then build using `make html` and the extension will be used by your `Sph [rtd-badge]: https://readthedocs.org/projects/sphinx-proof/badge/?version=latest [rtd-link]: https://sphinx-proof.readthedocs.io/en/latest/?badge=latest -[github-ci]: https://github.com/executablebooks/sphinx-proof/workflows/continuous-integration/badge.svg?branch=master +[github-ci]: https://github.com/executablebooks/sphinx-proof/workflows/continuous-integration/badge.svg?branch=main [github-link]: https://github.com/executablebooks/sphinx-proof -[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-proof/branch/master/graph/badge.svg +[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-proof/branch/main/graph/badge.svg [codecov-link]: https://codecov.io/gh/executablebooks/sphinx-proof diff --git a/docs/source/install.md b/docs/source/install.md index 37af7a2..fbb6197 100644 --- a/docs/source/install.md +++ b/docs/source/install.md @@ -26,6 +26,6 @@ To install `sphinx-proof` for package development: ```bash git clone https://github.com/executablebooks/sphinx-proof cd sphinx-proof -git checkout master +git checkout main pip install -e .[all] ```