Skip to content

Commit

Permalink
Add steps to the setup instructions and fix details to build the docs (
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhuppmann authored Feb 23, 2021
1 parent 53bc906 commit 589dff8
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ Detailed instructions to create a new repository from a template can be found

Then, make the following changes:

0. Change the text of the `LICENSE` file (optional).
0. Update the url in the license badge in this readme to point to the new repository.
0. Change the text of the [LICENSE](LICENSE) file (optional).
Visit [choosealicense.com](https://choosealicense.com) to find out which license is
right for your project.
0. Update the copyright (if other than IIASA) in this readme.
0. Update the url in the license badge in this readme to point to your new repository.
This will automatically change the license badge (if you changed the license).
0. Rename the folder `python_stub` to the intended package name.
0. Update the package name, author info and url in `setup.cfg`.
0. Update the package name, author info and copyright in `doc/source/conf.py`.
Expand All @@ -35,7 +39,7 @@ A GitHub Action workflow is configured to check that your commits conform to the
We recommend that you follow the [numpydoc](https://numpydoc.readthedocs.io)
docstring formatting guide.

Looking for more ideas to include fancy modules in your package?
Looking for more best-practice tools for scientific software development?
Take a look at the [cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) repository!

## Installation
Expand All @@ -46,7 +50,7 @@ Install the package including the requirements for building the docs.

## Building the docs

Navigate to the doc folder and run Sphinx.
Run Sphinx to build the docs!

make --directory=doc html

Expand Down

0 comments on commit 589dff8

Please sign in to comment.