CRAC doc generation with read the docs (#903)

Signed-off-by: belthlemar <[email protected]>
powsybl · May 28, 2024 · d7c26f4 · d7c26f4
1 parent ca67112
commit d7c26f4
Show file tree

Hide file tree

Showing 66 changed files with 10,993 additions and 0 deletions.
diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,27 @@
+# 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     = .
+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
+
+
+clean:
+	@echo "Removing $(SOURCEDIR)/reference/api"
+	@rm -rf "$(SOURCEDIR)/reference/api"
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+# 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)
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,10 @@
+These are the documentation sources for OpenRAO.  
+Please keep them up-to-date with your developments.  
+They are published on powsybl-openrao.readthedocs.io and pull requests are built and previewed automatically.  
+
+In order to build the docs locally, run the following commands:  
+~~~bash
+pip install -r docs/requirements.txt
+sphinx-build -a docs ./build-docs
+~~~
+Then open `build-docs/index.html` in your browser.
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/_static/img/CSA-profiles.png b/docs/_static/img/CSA-profiles.png
diff --git a/docs/_static/img/CracCreationContext.png b/docs/_static/img/CracCreationContext.png
diff --git a/docs/_static/img/Flows.png b/docs/_static/img/Flows.png
diff --git a/docs/_static/img/General-GLSK.png b/docs/_static/img/General-GLSK.png
diff --git a/docs/_static/img/HVDC_AC_model.png b/docs/_static/img/HVDC_AC_model.png
diff --git a/docs/_static/img/NativeCrac.png b/docs/_static/img/NativeCrac.png
diff --git a/docs/_static/img/Search-tree-with-combinations.png b/docs/_static/img/Search-tree-with-combinations.png
diff --git a/docs/_static/img/States_AUTO.png b/docs/_static/img/States_AUTO.png
diff --git a/docs/_static/img/angle_monitoring.png b/docs/_static/img/angle_monitoring.png
diff --git a/docs/_static/img/angle_monitoring_algorithm.png b/docs/_static/img/angle_monitoring_algorithm.png
diff --git a/docs/_static/img/busbar.png b/docs/_static/img/busbar.png
diff --git a/docs/_static/img/core-cne-structure.png b/docs/_static/img/core-cne-structure.png
diff --git a/docs/_static/img/core-cne.png b/docs/_static/img/core-cne.png
diff --git a/docs/_static/img/curative1.png b/docs/_static/img/curative1.png
diff --git a/docs/_static/img/curative2.png b/docs/_static/img/curative2.png
diff --git a/docs/_static/img/equally-balanced-GLSK.png b/docs/_static/img/equally-balanced-GLSK.png
diff --git a/docs/_static/img/farao3.jpg b/docs/_static/img/farao3.jpg
diff --git a/docs/_static/img/flow-diagram-nativeCrac.png b/docs/_static/img/flow-diagram-nativeCrac.png
diff --git a/docs/_static/img/flowcnec.png b/docs/_static/img/flowcnec.png
diff --git a/docs/_static/img/instants-states.png b/docs/_static/img/instants-states.png