Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 2.24 KB

README.md

File metadata and controls

57 lines (37 loc) · 2.24 KB
Raw

A template repo for IIASA Python projects

Copyright (c) 2021 IIASA

License Code style: black

Overview

Template repository for creating python packages and Sphinx-based documentation pages in line with the IIASA design guidelines

Configuration

To start a new Python package from this repo, click on the green Use this template button on top-right of this page. Detailed instructions to create a new repository from a template can be found here.

Then, make the following changes:

  1. Change the text of the LICENSE file (optional). Visit choosealicense.com to find out which license is right for your project.
  2. Update the copyright (if other than IIASA) in this readme.
  3. 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).
  4. Rename the folder python_stub to the intended package name.
  5. Update the package name, author info and url in setup.cfg.
  6. Update the package name, author info and copyright in doc/source/conf.py.
  7. Delete the configuration section from this readme and update the title and overview section.

Make sure to commit all changes to your new repository - then program away!

Recommendations

This package uses the Black code style. A GitHub Action workflow is configured to check that your commits conform to the style.

We recommend that you follow the numpydoc docstring formatting guide.

Looking for more best-practice tools for scientific software development? Take a look at the cookiecutter-hypermodern-python repository!

Installation

Install the package including the requirements for building the docs.

pip install --editable .[doc]

Building the docs

Run Sphinx to build the docs!

make --directory=doc html

The rendered html pages will be located in doc/build/html/index.html.