Skip to content

Add a readme for building the docs #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a readme for building the docs #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2aff6b
Add a readme for building the docs
danielhuppmann Jan 19, 2023
3715378
Bump/harmonize license year
danielhuppmann Jan 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
23 changes: 23 additions & 0 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.