Skip to content
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.

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

Fix rtd #191

Merged
merged 16 commits into from
Apr 9, 2024
9 changes: 9 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
API
====

.. toctree::
:maxdepth: 1
:caption: Contents:

Machine Learning <api/machine_learning>
Models <api/models>
22 changes: 22 additions & 0 deletions docs/source/api/machine_learning.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Machine Learning
==================

The machine learning class
---------------------------
This class does most of the heavy lifting for machine learning applications in the model.

.. currentmodule:: copro

.. autoclass:: machine_learning.MachineLearning
:members:
:undoc-members:
:show-inheritance:

Other functions
----------------
Functions for machine learning applications in the model.

.. automodule:: machine_learning
:members: load_clfs,define_scaling,predictive
:undoc-members:
:show-inheritance:
15 changes: 15 additions & 0 deletions docs/source/api/models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Models
=======

The models class
---------------------------
THe models class contains all the steps required to prepare and run the conflict projections.

.. note:: Currently, only a `RandomForestClassifier` is supported. Future work will include other classifiers.

.. currentmodule:: copro

.. autoclass:: models.MainModel
:members:
:undoc-members:
:show-inheritance:
11 changes: 5 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,15 @@ def __getattr__(cls, name):
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# html_static_path = ["../_static"]

html_css_files = [
"css/custom.css",
]
# html_css_files = [
# "css/custom.css",
# ]

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "_static/logo.png"

html_logo = "../_static/logo.png"

# -- Options for HTMLHelp output ---------------------------------------

Expand Down
6 changes: 4 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ application in mind, unravelling the interplay of socio-economic development, cl
Nevertheless, we put a lot of emphasis on making it flexible.
We hope that other, related questions about climate and conflict can be tackled as well, and that process understanding is deepened further.

Contents
---------------
.. toctree::
:maxdepth: 2
:caption: Contents:
:maxdepth: 1

Installation <installation>
API <api>

Authors
----------------
Expand Down