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
<liclass="toc-h3 nav-item toc-entry"><aclass="reference internal nav-link" href="#adding-a-new-tutorial">Adding a new tutorial</a></li>
417
+
</ul>
418
+
</li>
419
+
<liclass="toc-h2 nav-item toc-entry"><aclass="reference internal nav-link" href="#build-the-website-and-push-the-changes">Build the Website and Push the Changes</a></li>
<h1>geopython-tutorials<aclass="headerlink" href="#geopython-tutorials" title="Link to this heading">#</a></h1>
416
-
<p>Repository for Geospatial Python Tutorials</p>
432
+
<sectionid="geospatial-python-tutorials">
433
+
<h1>Geospatial Python Tutorials<aclass="headerlink" href="#geospatial-python-tutorials" title="Link to this heading">#</a></h1>
434
+
<p>This repository contains the notebooks and Jupyterbook configuration for the <aclass="reference external" href="https://www.geopythontutorials.com/">Geospatial Python Tutorials</a> website.</p>
435
+
<p>The website is a static website generated using the following technologies</p>
436
+
<ulclass="simple">
437
+
<li><p>All the content is based on Markdown files and Jupyter notebooks.</p></li>
438
+
<li><p>The HTML is generated using <aclass="reference external" href="https://jupyterbook.org/en/stable/intro.html">Jupyterbook</a>.</p></li>
439
+
<li><p>The webpages are hosted on <aclass="reference external" href="https://pages.github.com/">Github Pages</a>.</p></li>
440
+
<li><p>Comments are powered by <aclass="reference external" href="https://utteranc.es/">utterances</a>.</p></li>
441
+
</ul>
442
+
<sectionid="clone-the-repository">
443
+
<h2>Clone the Repository<aclass="headerlink" href="#clone-the-repository" title="Link to this heading">#</a></h2>
<h2>Installation<aclass="headerlink" href="#installation" title="Link to this heading">#</a></h2>
451
+
<p>The following instructions have been tested for Linux/Mac systems. I prefer conda for environment management so the instructions use conda, but if you prefer virtualenv, you can use it instead as well.</p>
452
+
<p>Create a new environment named <codeclass="docutils literal notranslate"><spanclass="pre">geopython-tutorials</span></code> and install dependencies. Optionally we also need <codeclass="docutils literal notranslate"><spanclass="pre">make</span></code> to build the source files.</p>
<h2>Updating the Contents<aclass="headerlink" href="#updating-the-contents" title="Link to this heading">#</a></h2>
463
+
<p>The homepage content is in the file <codeclass="docutils literal notranslate"><spanclass="pre">introduction.md</span></code>. All other content is generated from the <codeclass="docutils literal notranslate"><spanclass="pre">.ipynb</span></code> files in the <codeclass="docutils literal notranslate"><spanclass="pre">notebooks</span></code> folder. The table of content is in the <codeclass="docutils literal notranslate"><spanclass="pre">_toc.yml</span></code> file.</p>
464
+
<sectionid="editing-existing-tutorials">
465
+
<h3>Editing existing tutorials<aclass="headerlink" href="#editing-existing-tutorials" title="Link to this heading">#</a></h3>
466
+
<ulclass="simple">
467
+
<li><p>Edit the corresponding notebook in the <codeclass="docutils literal notranslate"><spanclass="pre">notebooks/</span></code> folder using Jupyterlab/Colab.</p></li>
468
+
</ul>
469
+
</section>
470
+
<sectionid="adding-a-new-tutorial">
471
+
<h3>Adding a new tutorial<aclass="headerlink" href="#adding-a-new-tutorial" title="Link to this heading">#</a></h3>
472
+
<ulclass="simple">
473
+
<li><p>Add the <codeclass="docutils literal notranslate"><spanclass="pre">.ipynb</span></code> file in the <codeclass="docutils literal notranslate"><spanclass="pre">notebooks/</span></code> folder.</p></li>
474
+
<li><p>Edit the <codeclass="docutils literal notranslate"><spanclass="pre">_toc.yml</span></code> file and add the section for the new tutorial.</p></li>
<h2>Build the Website and Push the Changes<aclass="headerlink" href="#build-the-website-and-push-the-changes" title="Link to this heading">#</a></h2>
480
+
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Makefile</span></code> contains several rules to execute the commands to build the website.</p>
481
+
<p>After making changes, run the following to build the HTML pages and preview them.</p>
<h2>License<aclass="headerlink" href="#license" title="Link to this heading">#</a></h2>
492
+
<p>All the tutorials are available under a <aclass="reference external" href="http://creativecommons.org/licenses/by/4.0/deed.en_US">Creative Commons Attribution 4.0 International License</a></p>
<liclass="toc-h3 nav-item toc-entry"><aclass="reference internal nav-link" href="#adding-a-new-tutorial">Adding a new tutorial</a></li>
548
+
</ul>
549
+
</li>
550
+
<liclass="toc-h2 nav-item toc-entry"><aclass="reference internal nav-link" href="#build-the-website-and-push-the-changes">Build the Website and Push the Changes</a></li>
This repository contains the notebooks and Jupyterbook configuration for the [Geospatial Python Tutorials](https://www.geopythontutorials.com/) website.
4
+
5
+
The website is a static website generated using the following technologies
6
+
7
+
* All the content is based on Markdown files and Jupyter notebooks.
8
+
* The HTML is generated using [Jupyterbook](https://jupyterbook.org/en/stable/intro.html).
9
+
* The webpages are hosted on [Github Pages](https://pages.github.com/).
10
+
* Comments are powered by [utterances](https://utteranc.es/).
The following instructions have been tested for Linux/Mac systems. I prefer conda for environment management so the instructions use conda, but if you prefer virtualenv, you can use it instead as well.
23
+
24
+
Create a new environment named `geopython-tutorials` and install dependencies. Optionally we also need `make` to build the source files.
25
+
26
+
```
27
+
conda create --name geopython-tutorials
28
+
conda activate geopython-tutorials
29
+
conda install pip
30
+
conda install make
31
+
pip install -r requirements.txt
32
+
```
33
+
34
+
## Updating the Contents
35
+
36
+
The homepage content is in the file `introduction.md`. All other content is generated from the `.ipynb` files in the `notebooks` folder. The table of content is in the `_toc.yml` file.
37
+
38
+
### Editing existing tutorials
39
+
40
+
* Edit the corresponding notebook in the `notebooks/` folder using Jupyterlab/Colab.
41
+
42
+
### Adding a new tutorial
43
+
44
+
* Add the `.ipynb` file in the `notebooks/` folder.
45
+
* Edit the `_toc.yml` file and add the section for the new tutorial.
46
+
47
+
## Build the Website and Push the Changes
48
+
49
+
The `Makefile` contains several rules to execute the commands to build the website.
50
+
51
+
After making changes, run the following to build the HTML pages and preview them.
52
+
53
+
```
54
+
make html
55
+
```
56
+
57
+
To push the changes to GitHub pages, run the following
58
+
59
+
60
+
```
61
+
make gh-pages
62
+
```
63
+
64
+
License
65
+
-------
66
+
67
+
All the tutorials are available under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/deed.en_US)
0 commit comments