Merge branch 'fix-sphinx-internal-docs-links' into 'master'

RFC: Fix Sphinx docummentation links See merge request mutt_data/soam!114
MuttData · Aug 9, 2021 · 659b337 · 659b337
2 parents 03464ea + d587eaa
commit 659b337
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.9.0
+current_version = 0.9.1
 tag = False
 
 [bumpversion:file:soam/__init__.py]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1 - 2021-08-10]
+
+### Fixed
+- Fixed links to notebooks and other sphinx docummentation.
+
 ## [0.9.0 - 2021-08-09]
 
 ### Removed

diff --git a/README.md b/README.md
@@ -106,17 +106,16 @@ _Note_: The `pdf_report` extra might need to run the following command before in
   $ `apt-get install texlive-xetex texlive-fonts-recommended libpoppler-cpp-dev`
 
 ## Quick start
-[Here](quickstart.ipynb) is an example for a quick start into SoaM. In it a time series with AAPL stock prices is loaded, processed and forecasted. As well, there's [other example](soamflowrun.ipynb) with the same steps, but exploding the power of flows.
+[Here](https://gitlab.com/mutt_data/soam/-/blob/master/notebook/examples/quickstart.ipynb) is an example for a quick start into SoaM. In it a time series with AAPL stock prices is loaded, processed and forecasted. As well, there's [other example](https://gitlab.com/mutt_data/soam/-/blob/master/notebook/examples/soamflowrun.ipynb) with the same steps, but exploding the power of flows.
 
 ## Usage
-For further info check our [end to end](end2end.md) example where we explained how SoaM will interact with Airflow on a generic project.
+For further info check our [end to end](https://mutt_data.gitlab.io/soam/end2end.html) example where we explained how SoaM will interact with Airflow and Cookiecutter on a generic project.
 
 ## Database management
 For database storing there are complementary tools:
-* [muttlib.dbcon](https://gitlab.com/mutt_data/muttlib/) for database connections.
-* [Decouple](https://github.com/henriquebastos/python-decouple) storing the database information in a separated file.  With a [settings.ini](soam/settings.ini) file to store the database credentials and general configurations, when modifying it don't change the keys names.
+* [Decouple](https://github.com/henriquebastos/python-decouple) storing the database information in a separated file. With a `settings.ini` file to store the database credentials and general configurations, when modifying it don't change the keys names.
 * [Alembic](https://alembic.sqlalchemy.org/en/latest/) to create the database migrations. A brief description is below.
-* [SQLAlchemy](https://docs.sqlalchemy.org/en/) as an ORM, the schemas of the tables are defined in[data_models](soam/data_models.py).
+* [SQLAlchemy](https://docs.sqlalchemy.org/en/) as an ORM, the schemas of the tables are defined in [data_models](https://gitlab.com/mutt_data/soam/-/blob/master/soam/data_models.py).
 
 ### Alembic
 This package uses alembic and expects you to use it!
@@ -150,7 +149,7 @@ For more alembic commands visit the [documentation](https://alembic.sqlalchemy.o
 
 ## Developers guide
 If you are going to develop SoaM, you should checkout the documentation directory before adding code,
-you can start in the [project structure document](documentation/source/project_structure.md).
+you can start in the [project structure document](https://mutt_data.gitlab.io/soam/project_structure.html).
 
 ## Testing
 To run the default testsuite run this:
@@ -198,7 +197,7 @@ pytest --mpl
 ```
 
 ## Contributing
-We appreciate for considering to help out maintaining this project. If you'd like to contribute please read our [contributing guidelines](CONTRIBUTING.md).
+We appreciate for considering to help out maintaining this project. If you'd like to contribute please read our [contributing guidelines](https://mutt_data.gitlab.io/soam/CONTRIBUTING.html).
 
 ## Rules of Thumb
 This section contains some recommendations when working with SoaM to avoid common mistakes:
@@ -209,11 +208,13 @@ This section contains some recommendations when working with SoaM to avoid commo
 
 ## Credits
 Alejandro Rusi <br>
+Diego Leguizamón <br>
 Diego Lizondo <br>
 Eugenio Scafati <br>
 Fabian Wolfmann <br>
 Francisco Lopez Destain <br>
 Guido Trucco <br>
+Hugo Daniel Viotti <br>
 Juan Martin Pampliega <br>
 Pablo Andres Lorenzatto <br>
 Wenceslao Villegas

diff --git a/end2end.md → documentation/source/end2end.md b/end2end.md → documentation/source/end2end.md
diff --git a/documentation/source/end2end.rst b/documentation/source/end2end.rst
diff --git a/soam/__init__.py b/soam/__init__.py
@@ -1,3 +1,3 @@
 """Version."""
 
-__version__ = '0.9.0'
+__version__ = '0.9.1'