Merge branch '162-fix-m2r2-issue-with-links' into 'master'

RFC: Resolve "Fix ~m2r2~ issue with links"

Closes #162

See merge request mutt_data/soam!118

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.9.1
+current_version = 0.9.2
 tag = False
 
 [bumpversion:file:soam/__init__.py]

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.2 - 2021-08-13]
+
+### Fixed
+- Links in docs.
+
 ## [0.9.1 - 2021-08-10]
 
 ### Fixed

documentation/source/developers_starting_point.md

@@ -32,8 +32,8 @@ pip install --upgrade git+https://gitlab.com/mutt_data/muttlib#egg=muttlib
 
 # Next Steps
 * If you already have the project running the last step before making your first commit is to review the
-[development pipeline](development_pipeline.md).
-* If you want more information about the main classes or patterns in the project go to [classes document](classes.md).
+[development pipeline](./development_pipeline.html).
+* If you want more information about the main classes or patterns in the project go to [classes document](./classes.html).
 * If you need to understand a library, technology or concept in the project you can check the
-[references](references.md).
+[references](./references.html).
 

documentation/source/mlflow_tracking.md

@@ -16,4 +16,4 @@ To visualize the logged runs just execute the script that contains the flow you
 in the same directory as your script, then go to http://localhost:5000 on your browser to view the logs (if the default settings
 were used).
 
-Follow [this notebook](../../notebook/examples/mlflow_log_test.ipynb) to see an example on how to use this feature!
+Follow [this notebook](https://gitlab.com/mutt_data/soam/-/blob/master/notebook/examples/mlflow_log_test.ipynb) to see an example on how to use this feature!

documentation/source/project_structure.md

@@ -1,56 +1,56 @@
 # Directory structure
 
 ## root
-### [gitignore](../../.gitignore)
+### [gitignore](https://gitlab.com/mutt_data/soam/-/blob/master/.gitignore)
 This [description file](https://git-scm.com/docs/gitignore) specifies the excluded documents and folders from git.
 
-### [README](../../README.md)
+### [README](./README.html)
 This document contains a brief overview of the project working and how to use it, it's oriented to the users of the
 package.
 
-### [setup.py](../../setup.py)
+### [setup.py](https://gitlab.com/mutt_data/soam/-/blob/master/setup.py)
 This [configuration file](https://packaging.python.org/guides/distributing-packages-using-setuptools/#setup-py)
 determines how the SoaM package is going to be installed and what commands it supports.
 
-### [setup.cfg](../../setup.cfg)
+### [setup.cfg](https://gitlab.com/mutt_data/soam/-/blob/master/setup.cfg)
 This [ini file](https://packaging.python.org/guides/distributing-packages-using-setuptools/#setup-cfg) defines default
 options for the setup.py commands.
 
-## documentation
+## [documentation](./development_pipeline.html#documentation)
 Contains the technical documentation for the project, it's oriented to the development team.
 
-### images
+### [images](https://gitlab.com/mutt_data/soam/-/tree/master/documentation/images)
 The diagrams and visualizations for the documentation.
 
-### [classes](classes.md)
+### [classes](./classes.html)
 Explanation and diagrams of the classes and patterns in the project.
 
-### [developers starting point](developers_starting_point.md)
+### [developers starting point](./developers_starting_point.html)
 Steps description to setup the project for development. If you are new in SoaM this is your next document in your path
 to start developing.
 
 ### project structure
 This document :D
 
-### [references](references.md)
+### [references](./references.html)
 Papers, articles and videos to understand the theoretical background, libraries and technologies used in the project.
 
 [//comment]: # (TODO: ### architecture)
 [//comment]: # (TODO: create some expected or possible architecture implementations.)
 
-## notebook
+## [notebook](https://gitlab.com/mutt_data/soam/-/tree/master/notebook)
 There are different proof of concepts, tests and usage examples.
 
-## soam
+## [soam](https://gitlab.com/mutt_data/soam/-/tree/master/soam)
 The root of the source code for the project.
 
-### db_migrations
+### [db_migrations](https://gitlab.com/mutt_data/soam/-/tree/master/soam/db_migrations)
 This directory contains the migrations for the database that stores the data and runs with the DBSaver.
 
-### [alembic.ini](../../soam/alembic.ini)
+### [alembic.ini](https://gitlab.com/mutt_data/soam/-/blob/master/soam/alembic.ini)
 Configures the alembic library to manage the migrations for the DBSaver.
 
-### resources
+### [resources](https://gitlab.com/mutt_data/soam/-/tree/master/soam/resources)
 Files that will be used in the pipeline, like a template for an email report in a postprocess step.
 
 [//comment]: # (TODO: review if this directory is outdated or not used any more.)

soam/__init__.py

@@ -1,3 +1,3 @@
 """Version."""
 
-__version__ = '0.9.1'
+__version__ = '0.9.2'