You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<h2>Create the docs for the first time and upload to readthedocs<aclass="headerlink" href="#create-the-docs-for-the-first-time-and-upload-to-readthedocs" title="Link to this heading"></a></h2>
362
-
<p>Install <codeclass="docutils literal notranslate"><spanclass="pre">myst-parser==3.0.1</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">Sphinx==7.2.6</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">Sphinx-rtd-theme==2.0.0</span></code> in your environment and the modules to your <codeclass="docutils literal notranslate"><spanclass="pre">requirements.txt</span></code> file.</p>
362
+
<p>Install <codeclass="docutils literal notranslate"><spanclass="pre">myst-parser==3.0.1</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">Sphinx==7.2.6</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">Sphinx-rtd-theme==2.0.0</span></code> in your environment and add the modules to your <codeclass="docutils literal notranslate"><spanclass="pre">requirements.txt</span></code> file.</p>
<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 <codeclass="docutils literal notranslate"><spanclass="pre">conf.py</span></code> file will be generated in the <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">conf.py</span></code> file together with other files will be generated in the <codeclass="docutils literal notranslate"><spanclass="pre">docs/source</span></code> folder. You can edit the configuration file. In our case, we added some extensions and plugins:</p>
373
373
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="c1"># -- General configuration ---------------------------------------------------</span>
@@ -394,7 +394,7 @@ <h2>Create the docs for the first time and upload to readthedocs<a class="header
394
394
</pre></div>
395
395
</div>
396
396
<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>
398
398
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="c1"># Read the Docs configuration file</span>
399
399
<spanclass="c1"># See https://docs.readthedocs.io/en/stable/config-file/v2.html for details</span>
Copy file name to clipboardExpand all lines: docs/build/html/_sources/Tips-and-tricks-for-developers.md.txt
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -287,7 +287,7 @@ Prior to that you should update the paths to the volumes (/data, /home/avilanov/
287
287
288
288
## Create the docs for the first time and upload to readthedocs
289
289
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.
291
291
292
292
```
293
293
conda activate providentia-env_v3.0.0
@@ -300,7 +300,7 @@ cd docs
300
300
sphinx-quickstart
301
301
```
302
302
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:
304
304
305
305
```
306
306
# -- General configuration ---------------------------------------------------
@@ -330,7 +330,7 @@ make html
330
330
331
331
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.
332
332
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:
Copy file name to clipboardExpand all lines: docs/source/Tips-and-tricks-for-developers.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -287,7 +287,7 @@ Prior to that you should update the paths to the volumes (/data, /home/avilanov/
287
287
288
288
## Create the docs for the first time and upload to readthedocs
289
289
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.
291
291
292
292
```
293
293
conda activate providentia-env_v3.0.0
@@ -300,7 +300,7 @@ cd docs
300
300
sphinx-quickstart
301
301
```
302
302
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:
304
304
305
305
```
306
306
# -- General configuration ---------------------------------------------------
@@ -330,7 +330,7 @@ make html
330
330
331
331
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.
332
332
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:
0 commit comments