Merge pull request #79 from jpolz/sphinx_docs

Sphinx docs 2
pycomlink · May 5, 2021 · d546dd6 · d546dd6
2 parents a686067 + 772ad29
commit d546dd6
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 18 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,8 +3,9 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+********************************************
 Welcome to pycomlink's documentation!
-=====================================
+********************************************
 
 A Python library to process commercial microwave link data.
 

diff --git a/docs/readme_link.rst b/docs/readme_link.rst
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,5 +1,6 @@
+**********************
 pycomlink
-=========
+**********************
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/source/pycomlink.io.rst b/docs/source/pycomlink.io.rst
@@ -1,6 +1,6 @@
-<<<<<<< HEAD
+**********************
 IO
-====================
+**********************
 
 cmlh5\_to\_xarray
 -----------------

diff --git a/docs/source/pycomlink.processing.rst b/docs/source/pycomlink.processing.rst
@@ -1,5 +1,6 @@
+**********************
 Processing
-============================
+**********************
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/source/pycomlink.processing.wet_dry.rst b/docs/source/pycomlink.processing.wet_dry.rst
@@ -1,5 +1,6 @@
+**********************
 wet\_dry
-========
+**********************
 
 cnn
 ----------------------------------------

diff --git a/docs/source/pycomlink.rst b/docs/source/pycomlink.rst
@@ -1,5 +1,6 @@
+**********************
 pycomlink
-=========
+**********************
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/source/pycomlink.spatial.rst b/docs/source/pycomlink.spatial.rst
@@ -1,5 +1,6 @@
+**********************
 Spatial
-=========================
+**********************
 
 coverage
 ---------------------------------

diff --git a/docs/source/pycomlink.tests.rst b/docs/source/pycomlink.tests.rst
@@ -1,5 +1,6 @@
+**********************
 pycomlink.tests package
-=======================
+**********************
 
 Submodules
 ----------

diff --git a/docs/source/pycomlink.util.rst b/docs/source/pycomlink.util.rst
@@ -1,5 +1,6 @@
+**********************
 Util
-======================
+**********************
 
 maintenance
 ---------------------------------

diff --git a/docs/source/pycomlink.validation.rst b/docs/source/pycomlink.validation.rst
@@ -1,5 +1,6 @@
+**********************
 Validation
-============================
+**********************
 
 stats
 ---------------------------------

diff --git a/docs/source/pycomlink.vis.rst b/docs/source/pycomlink.vis.rst
@@ -1,5 +1,6 @@
+**********************
 Visualisation
-=====================
+**********************
 
 interactive\_maps
 --------------------------------------

diff --git a/docs/whats-new.rst b/docs/whats-new.rst
@@ -1,5 +1,6 @@
+**********************
 What's New
-==========
+**********************
 
 v0.2.4
 ------
@@ -144,4 +145,4 @@ Bug fixes
 v0.1.1
 ------
 
-No info for older version...
+No info for older version...