Skip to content

Commit 09cca48

Browse files
committed
update old links pointing to rst files
1 parent a0c48d2 commit 09cca48

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.dev.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ path/to/package/
1010
├── .gitignore
1111
├── pyproject.toml
1212
├── .prospector.yml
13-
├── CHANGELOG.rst
14-
├── CODE_OF_CONDUCT.rst
15-
├── CONTRIBUTING.rst
13+
├── CHANGELOG.md
14+
├── CODE_OF_CONDUCT.md
15+
├── CONTRIBUTING.md
1616
├── docs
1717
│   ├── conf.py
1818
│   ├── index.rst
@@ -24,8 +24,8 @@ path/to/package/
2424
│   ├── __init__.py
2525
│   ├── __version__.py
2626
│   └── package.py
27-
├── README.rst
28-
├── project_setup.rst
27+
├── README.md
28+
├── project_setup.md
2929
├── requirements.txt
3030
├── setup.cfg
3131
├── setup.py

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ an empty Python package. Features include:
1313
- [Default Github actions]({{cookiecutter.project_name}}/.github/workflows) for building, testing and deployment
1414
- Code style checking,
1515
- [Editorconfig]({{cookiecutter.project_name}}/.editorconfig),
16-
- Miscellaneous files, such as [Change log]({{cookiecutter.project_name}}/CHANGELOG.rst), [Code of Conduct]({{cookiecutter.project_name}}/CODE_OF_CONDUCT.rst), and [Contributing guidelines]({{cookiecutter.project_name}}/CONTRIBUTING.rst),
17-
- A [README]({{cookiecutter.project_name}}/README.rst) and [a separate document]({{cookiecutter.project_name}}/project_setup.md) with extensive documentation about project setup.
16+
- Miscellaneous files, such as [Change log]({{cookiecutter.project_name}}/CHANGELOG.md), [Code of Conduct]({{cookiecutter.project_name}}/CODE_OF_CONDUCT.md), and [Contributing guidelines]({{cookiecutter.project_name}}/CONTRIBUTING.md),
17+
- A [README]({{cookiecutter.project_name}}/README.md) and [a separate document]({{cookiecutter.project_name}}/project_setup.md) with extensive documentation about project setup.
1818
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/)
1919

2020
## Badges
@@ -76,10 +76,10 @@ Good job! You have now generated the skeleton for your package:
7676

7777
```text
7878
my-python-project/
79-
├── CHANGELOG.rst
79+
├── CHANGELOG.md
8080
├── CITATION.cff
81-
├── CODE_OF_CONDUCT.rst
82-
├── CONTRIBUTING.rst
81+
├── CODE_OF_CONDUCT.md
82+
├── CONTRIBUTING.md
8383
├── docs
8484
│ ├── conf.py
8585
│ ├── index.rst
@@ -96,7 +96,7 @@ my-python-project/
9696
│ └── __version__.py
9797
├── NOTICE
9898
├── project_setup.md
99-
├── README.rst
99+
├── README.md
100100
├── setup.cfg
101101
├── setup.py
102102
└── tests
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
include CITATION.cff
22
include LICENSE
33
include NOTICE
4-
include README.rst
4+
include README.md

{{cookiecutter.project_name}}/project_setup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ help you decide which tool to use for packaging.
8080
file can be safely removed (or you can just leave it there).
8181
- To put the documentation on [ReadTheDocs](https://readthedocs.org), log in to your ReadTheDocs account, and import
8282
the repository (under 'My Projects').
83-
- Include the link to the documentation in your project's [README.rst](README.rst).
83+
- Include the link to the documentation in your project's [README.md](README.md).
8484
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=writingdocumentation)
8585

8686
## Coding style conventions and code quality
@@ -122,7 +122,7 @@ save it as a secret called `PYPI_TOKEN` on [Settings page]({{cookiecutter.reposi
122122
- The project is set up with a logging example.
123123
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=logging)
124124

125-
## CHANGELOG.rst
125+
## CHANGELOG.md
126126

127127
- Document changes to your software package
128128
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/releases?id=changelogmd)
@@ -133,12 +133,12 @@ save it as a secret called `PYPI_TOKEN` on [Settings page]({{cookiecutter.reposi
133133
- It only makes sense to do this once there is something to cite (e.g., a software release with a DOI).
134134
- Follow the [making software citable](https://guide.esciencecenter.nl/#/citable_software/making_software_citable) section in the guide.
135135

136-
## CODE\_OF\_CONDUCT.rst
136+
## CODE\_OF\_CONDUCT.md
137137

138138
- Information about how to behave professionally
139139
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=code-of-conduct)
140140

141-
## CONTRIBUTING.rst
141+
## CONTRIBUTING.md
142142

143143
- Information about how to contribute to this software package
144144
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=contribution-guidelines)

0 commit comments

Comments
 (0)