Merge pull request #28 from OssamaElshimy/Docs

Docs

README.md

@@ -45,6 +45,7 @@ might have to be rewritten (utils.py)
   - [Usage](#usage)
   - [Contribute](#contribute)
   - [Tests](#tests)
+  - [Docs](#docs)
   - [License](#license)
 
 ## Description
@@ -140,6 +141,29 @@ pip install .[dev]
 pytest tests
 ```
 
+## Docs
+
+Activate the topotherm environment:
+
+```conda activate topotherm```
+
+Then, install the optional requirements:
+
+```pip install .[docs]```
+
+In the topotherm root directory run:
+
+```sphinx-apidoc -o docs/source/ .```
+
+Then make the hmtl documentation files: ::
+
+```
+cd docs
+make html
+```
+
+The documentation is located under docs/build/html.
+
 ## License
 
 [MIT](https://en.wikipedia.org/wiki/MIT_License), see LICENSE file.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/modules.rst

@@ -0,0 +1,8 @@
+topotherm-0.2.0
+===============
+
+.. toctree::
+   :maxdepth: 4
+
+   setup
+   topotherm

docs/setup.rst

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+
+import sys 
+
+project = 'Topotherm'
+copyright = '2024, Lambert, Jerry and Ceruti, Amedeo'
+author = 'Jerry Lambert & Amedeo Ceruti'
+release = '0.2.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/documentation.rst

@@ -0,0 +1,28 @@
+Documentation
+=========
+
+Activate the topotherm environment: ::
+
+ conda activate topotherm
+
+Then, install the optional requirements if needed ::
+
+ pip install sphinx sphinx-rtd-theme or pip install .[docs]
+
+In the topotherm root directory run: ::
+
+ sphinx-apidoc -o docs/source/ .
+
+Then make the hmtl documentation files: :: 
+
+ cd docs
+ make html
+
+The documentation is located under docs/build/html
+
+Adding New Pages
+-----------------
+
+Create a new rts file under docs/source
+
+Add the name of the created page in index.rst

docs/source/index.rst

@@ -0,0 +1,23 @@
+.. Topotherm documentation master file, created by
+   sphinx-quickstart on Wed Oct  9 10:16:32 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Topotherm documentation
+=======================
+
+**Topotherm** is a pyomo-based mixed-integer linear programming district heating
+network design model which scales well into larger districts for single
+and mulitple time steps.
+
+.. toctree::   
+   overview
+   install
+   solver
+   usage
+   methodology 
+   documentation
+   topotherm
+   :maxdepth: 2
+   :caption: Contents:
+

docs/source/install.rst

@@ -0,0 +1,28 @@
+Install
+=========
+
+Use git to clone this repository into your computer. Then, install topotherm
+with a package manager such as Anaconda, or directly with Python. ::
+
+   git
+   git clone https://github.com/jylambert/topotherm.git
+
+Python
+---------
+
+This can also be done with venv or equivalent. :: 
+
+   Python
+   cd topotherm
+   python setup.py install
+
+Anaconda or mamba
+---------------------
+
+We recommend to install the dependencies with anaconda or mamba: ::
+
+ conda
+ cd topotherm
+ conda create -n topotherm python
+ conda activate topotherm
+ pip install -e .