Skip to content

Commit b8fff9f

Browse files
committed
Update docs
1 parent eab3ce5 commit b8fff9f

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed
60 Bytes
Binary file not shown.
60 Bytes
Binary file not shown.
60 Bytes
Binary file not shown.

docs/build/html/Tips-and-tricks-for-developers.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ <h2>Run Providentia inside Docker container<a class="headerlink" href="#run-prov
359359
</section>
360360
<section id="create-the-docs-for-the-first-time-and-upload-to-readthedocs">
361361
<h2>Create the docs for the first time and upload to readthedocs<a class="headerlink" href="#create-the-docs-for-the-first-time-and-upload-to-readthedocs" title="Link to this heading"></a></h2>
362-
<p>Install <code class="docutils literal notranslate"><span class="pre">myst-parser==3.0.1</span></code>, <code class="docutils literal notranslate"><span class="pre">Sphinx==7.2.6</span></code> and <code class="docutils literal notranslate"><span class="pre">Sphinx-rtd-theme==2.0.0</span></code> in your environment and the modules to your <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> file.</p>
362+
<p>Install <code class="docutils literal notranslate"><span class="pre">myst-parser==3.0.1</span></code>, <code class="docutils literal notranslate"><span class="pre">Sphinx==7.2.6</span></code> and <code class="docutils literal notranslate"><span class="pre">Sphinx-rtd-theme==2.0.0</span></code> in your environment and add the modules to your <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> file.</p>
363363
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">activate</span> <span class="n">providentia</span><span class="o">-</span><span class="n">env_v3</span><span class="mf">.0.0</span>
364364
<span class="n">pip</span> <span class="n">install</span> <span class="n">myst</span><span class="o">-</span><span class="n">parser</span><span class="o">==</span><span class="mf">3.0.1</span> <span class="n">Sphinx</span><span class="o">==</span><span class="mf">7.2.6</span> <span class="n">Sphinx</span><span class="o">-</span><span class="n">rtd</span><span class="o">-</span><span class="n">theme</span><span class="o">==</span><span class="mf">2.0.0</span>
365365
</pre></div>
@@ -369,7 +369,7 @@ <h2>Create the docs for the first time and upload to readthedocs<a class="header
369369
<span class="n">sphinx</span><span class="o">-</span><span class="n">quickstart</span>
370370
</pre></div>
371371
</div>
372-
<p>This will ask you a few questions (we answered with yes to the question of whether we want to separate source and build folders) and a <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> file will be generated in the <code class="docutils literal notranslate"><span class="pre">docs/source</span></code> folder. You can edit the configuration file. In our case, we add some extensions and plugins:</p>
372+
<p>This will ask you a few questions (we answered with yes to the question of whether we want to separate source and build folders) and a <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> file together with other files will be generated in the <code class="docutils literal notranslate"><span class="pre">docs/source</span></code> folder. You can edit the configuration file. In our case, we added some extensions and plugins:</p>
373373
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># -- General configuration ---------------------------------------------------</span>
374374
<span class="c1"># https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration</span>
375375

@@ -394,7 +394,7 @@ <h2>Create the docs for the first time and upload to readthedocs<a class="header
394394
</pre></div>
395395
</div>
396396
<p>Here you might get some errors related to the format of your .md files, fix them and run the commands again. This will generate the HTML files, you can open them from the browser to make sure they look correct.</p>
397-
<p>Now create an account and project in https://app.readthedocs.org/, and associate it with your project, which must be open source. To show the documentation, you will need to generate the file .readthedocs.yaml in your repository. Ours looks like this:</p>
397+
<p>Now create an account and project in https://app.readthedocs.org/, and associate it with your project, which must be open source. To show the documentation, you will need to create the file .readthedocs.yaml in your repository. Ours looks like this:</p>
398398
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Read the Docs configuration file</span>
399399
<span class="c1"># See https://docs.readthedocs.io/en/stable/config-file/v2.html for details</span>
400400

docs/build/html/_sources/Tips-and-tricks-for-developers.md.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Prior to that you should update the paths to the volumes (/data, /home/avilanov/
287287

288288
## Create the docs for the first time and upload to readthedocs
289289

290-
Install `myst-parser==3.0.1`, `Sphinx==7.2.6` and `Sphinx-rtd-theme==2.0.0` in your environment and the modules to your `requirements.txt` file.
290+
Install `myst-parser==3.0.1`, `Sphinx==7.2.6` and `Sphinx-rtd-theme==2.0.0` in your environment and add the modules to your `requirements.txt` file.
291291

292292
```
293293
conda activate providentia-env_v3.0.0
@@ -300,7 +300,7 @@ cd docs
300300
sphinx-quickstart
301301
```
302302

303-
This will ask you a few questions (we answered with yes to the question of whether we want to separate source and build folders) and a `conf.py` file will be generated in the `docs/source` folder. You can edit the configuration file. In our case, we add some extensions and plugins:
303+
This will ask you a few questions (we answered with yes to the question of whether we want to separate source and build folders) and a `conf.py` file together with other files will be generated in the `docs/source` folder. You can edit the configuration file. In our case, we added some extensions and plugins:
304304

305305
```
306306
# -- General configuration ---------------------------------------------------
@@ -330,7 +330,7 @@ make html
330330

331331
Here you might get some errors related to the format of your .md files, fix them and run the commands again. This will generate the HTML files, you can open them from the browser to make sure they look correct.
332332

333-
Now create an account and project in https://app.readthedocs.org/, and associate it with your project, which must be open source. To show the documentation, you will need to generate the file .readthedocs.yaml in your repository. Ours looks like this:
333+
Now create an account and project in https://app.readthedocs.org/, and associate it with your project, which must be open source. To show the documentation, you will need to create the file .readthedocs.yaml in your repository. Ours looks like this:
334334

335335
```
336336
# Read the Docs configuration file

docs/source/Tips-and-tricks-for-developers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Prior to that you should update the paths to the volumes (/data, /home/avilanov/
287287

288288
## Create the docs for the first time and upload to readthedocs
289289

290-
Install `myst-parser==3.0.1`, `Sphinx==7.2.6` and `Sphinx-rtd-theme==2.0.0` in your environment and the modules to your `requirements.txt` file.
290+
Install `myst-parser==3.0.1`, `Sphinx==7.2.6` and `Sphinx-rtd-theme==2.0.0` in your environment and add the modules to your `requirements.txt` file.
291291

292292
```
293293
conda activate providentia-env_v3.0.0
@@ -300,7 +300,7 @@ cd docs
300300
sphinx-quickstart
301301
```
302302

303-
This will ask you a few questions (we answered with yes to the question of whether we want to separate source and build folders) and a `conf.py` file will be generated in the `docs/source` folder. You can edit the configuration file. In our case, we add some extensions and plugins:
303+
This will ask you a few questions (we answered with yes to the question of whether we want to separate source and build folders) and a `conf.py` file together with other files will be generated in the `docs/source` folder. You can edit the configuration file. In our case, we added some extensions and plugins:
304304

305305
```
306306
# -- General configuration ---------------------------------------------------
@@ -330,7 +330,7 @@ make html
330330

331331
Here you might get some errors related to the format of your .md files, fix them and run the commands again. This will generate the HTML files, you can open them from the browser to make sure they look correct.
332332

333-
Now create an account and project in https://app.readthedocs.org/, and associate it with your project, which must be open source. To show the documentation, you will need to generate the file .readthedocs.yaml in your repository. Ours looks like this:
333+
Now create an account and project in https://app.readthedocs.org/, and associate it with your project, which must be open source. To show the documentation, you will need to create the file .readthedocs.yaml in your repository. Ours looks like this:
334334

335335
```
336336
# Read the Docs configuration file

0 commit comments

Comments
 (0)