De-duplicate the documentation welcome section and fix ipython code-b…

…lock (#302)
RoseauTechnologies · Dec 27, 2024 · 951853f · 951853f
1 parent 1e991e1
commit 951853f
Show file tree

Hide file tree

Showing 6 changed files with 178 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 ![pre-commit](https://github.com/RoseauTechnologies/Roseau_Load_Flow/actions/workflows/pre-commit.yml/badge.svg)
 [![Documentation Status](https://readthedocs.org/projects/roseau-load-flow/badge/?version=latest)](https://roseau-load-flow.readthedocs.io/en/latest/?badge=latest)
 
+<!-- start rlf-pitch -->
+
 _Roseau Load Flow_ is a powerful load flow solver and static analysis tool that offers:
 
 - **Multi-phase**, **unbalanced** power flow analysis
@@ -21,6 +23,8 @@ In addition to the following **unique** set of features:
 - Support for **flexible**, voltage-dependent, loads directly in the Newton algorithm for better
   convergence and stability
 
+<!-- end rlf-pitch -->
+
 This project is compatible with Python version 3.10 and newer. The
 [installation instructions](https://roseau-load-flow.roseautechnologies.com/Installation.html)
 will guide you through the installation process. If you are new to _Roseau Load Flow_, we recommend
@@ -43,11 +47,15 @@ Read more at [License](https://roseau-load-flow.roseautechnologies.com/License.h
 
 ## Network data
 
+<!-- start rlf-networks -->
+
 _Roseau Load Flow_ ships with a sample of 20 low-voltage and 20 medium-voltage feeder networks. Each
 network is provided with its summer and winter load points. At _Roseau Technologies_, we can provide
 the major part of the French medium and low voltage networks on demand. For more information, please
 contact us at [email protected].
 
+<!-- end rlf-networks -->
+
 <div align="center">
   <img alt="Catalogue of networks" src="https://github.com/RoseauTechnologies/Roseau_Load_Flow/blob/main/doc/_static/Network/Catalogue.png?raw=True" />
 </div>

diff --git a/doc/Installation.md b/doc/Installation.md
@@ -114,7 +114,7 @@ the corresponding functions. They can be installed with the
 If you are using Jupyter Notebooks, you can install `roseau-load-flow` directly from a notebook
 cell with:
 
-```python-console
+```ipython
 In [1]: %pip install roseau-load-flow
 ```
 

diff --git a/doc/License.md b/doc/License.md
@@ -124,7 +124,7 @@ variable:
    ROSEAU_LOAD_FLOW_LICENSE_KEY="A8C6DA-9405FB-E74FB9-C71C3C-207661-V3"
    ```
 2. Add a cell to the beginning of your notebook with the following content and execute it:
-   ```python-console
+   ```ipython
    %pip install python-dotenv
    %load_ext dotenv
    %dotenv

diff --git a/doc/index.md b/doc/index.md
@@ -15,32 +15,15 @@ myst:
 
 # Welcome to the Roseau Load Flow documentation
 
-_Roseau Load Flow_ is a powerful load flow solver and static analysis tool that offers:
-
-- **Multi-phase**, **unbalanced** power flow analysis
-- A performance optimized solver written in C++
-- A catalogue of real-world transformer and line models
-- An ergonomic object-oriented Python interface with unit-aware quantities
-- A comprehensive documentation with code examples
-- Real-world distribution network data samples in the library (with more available on request)
-
-In addition to the following **unique** set of features:
-
-- Support for _floating neutrals_ for loads and sources
-- Four-wire multi-phase modelling with no Kron's reduction, no transformations, no assumptions on the
-  network topology and no implicit earthing everywhere
-- Support for **flexible**, voltage-dependent, loads directly in the Newton algorithm for better
-  convergence and stability
-
-This software is developed by [Roseau Technologies](https://www.roseautechnologies.com/en).
-<a href="https://www.linkedin.com/company/roseau-technologies/"><i class="fa-brands fa-linkedin" ></i></a>
-<a href="https://github.com/RoseauTechnologies/"><i class="fa-brands fa-github" ></i></a>
-
-_Roseau Load Flow_ ships with a sample of 20 low-voltage and 20 medium-voltage feeder networks. Each
-network is provided with its summer and winter load points. At _Roseau Technologies_, we can provide
-the major part of the French medium and low voltage networks on demand. For more information, please
-contact us at
-[[email protected]](mailto:[email protected]).
+```{include} ../README.md
+:start-after: <!-- start rlf-pitch -->
+:end-before: <!-- end rlf-pitch -->
+```
+
+```{include} ../README.md
+:start-after: <!-- start rlf-networks -->
+:end-before: <!-- end rlf-networks -->
+```
 
 <iframe src="./_static/Network/Catalogue.html" height="600px" width="100%" frameborder="0"></iframe>
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -73,6 +73,7 @@ doc = [
     "sphinxcontrib-bibtex>=2.5.0",
     "sphinx-sitemap>=2.5.1",
     "sphinxext-opengraph>=0.9.1",
+    "ipython>=8.31.0",
 ]
 
 [tool.uv]

diff --git a/uv.lock b/uv.lock