diff --git a/LICENSE b/LICENSE index f2c20d5..105d7ca 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 IIASA +Copyright (c) 2021-2023 IIASA Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 2aad922..81d1948 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # A template repo for IIASA Python projects -Copyright (c) 2021 IIASA +Copyright (c) 2021-2023 IIASA ![License](https://img.shields.io/github/license/iiasa/python-stub) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..3630b84 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,23 @@ +Building the docs +================== + +We use Sphinx and restructured text (rst) for building the documentation pages. + +Writing in Restructured Text +---------------------------- + +There are a number of guides to get started, for example +on [sourceforge](https://docutils.sourceforge.io/docs/user/rst/quickref.html). + +Building the documentation pages +-------------------------------- + +On *nix, from the command line, run:: + + make html + +On Windows, from the command line, run:: + + ./make.bat + +The rendered html pages will be located in `doc/build/html/index.html`. \ No newline at end of file