Merge pull request #925 from wkerzendorf/docs/fix_changelog

Docs/fix changelog
tardis-sn · Apr 29, 2019 · c2a89ce · c2a89ce
2 parents 3f2102f + 9b7a36e
commit c2a89ce
Show file tree

Hide file tree

Showing 9 changed files with 443 additions and 843 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -55,7 +55,7 @@ script:
     - set -e
     - conda install -y -c conda-forge nodejs
     - npm install -g github-changes
-    - github-changes -o tardis-sn -r tardis --only-pulls --use-commit-body -f CHANGELOG.rst -k $GITHUB_CHANGES_OAUTH
+    - github-changes -o tardis-sn -r tardis --only-pulls --use-commit-body -f CHANGELOG.md -k $GITHUB_CHANGES_OAUTH
     - python setup.py build_docs
     - pip install doctr
     - git lfs uninstall

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/docs/changelog.rst b/docs/changelog.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,10 +51,15 @@
     'numpydoc',
     'nbsphinx',
     'sphinx.ext.autodoc',
-    'sphinx-jsonschema'
+    'sphinx-jsonschema',
+    'recommonmark'
 ]
 
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+#    '.txt': 'markdown',
+    '.md': 'markdown',
+}
 ## get's rid of many toctree contains errors: see https://github.com/phn/pytpm/issues/3#issuecomment-12133978
 numpydoc_show_class_members = False
 extensions += ['matplotlib.sphinxext.plot_directive',

diff --git a/docs/index.rst b/docs/index.rst
@@ -34,6 +34,7 @@ Using Tardis
     :maxdepth: 2
 
     installation
+    CHANGELOG.md
     quickstart
     running/index
     examples/index
@@ -62,7 +63,6 @@ Developing Tardis
     issues
     workflow/development_workflow
     runnints_tests
-    changelog
 
 ==========
 References

diff --git a/tardis_env27.yml b/tardis_env27.yml
diff --git a/tardis_env3.yml b/tardis_env3.yml
@@ -41,6 +41,7 @@ dependencies:
 - sphinx_bootstrap_theme
 - sphinxcontrib-bibtex
 - sphinx_rtd_theme
+- recommonmark
 
 #Test/Coverage requirements
 - git-lfs