diff --git a/ChangeLog.md b/ChangeLog.md new file mode 120000 index 00000000..9e080e26 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1 @@ +doc/ChangeLog.md \ No newline at end of file diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 24fccf0e..40bbedc8 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -19,7 +19,7 @@ add_dependencies(docs_sphinx app4triqs_c) # cp_rs is a script in cpp2py/bin, it mimics cp -rs on Linux # and filters the relevant extension # ------------------------------------------------------------------------------------------------ -set(EXT_FOR_DOC "rst png txt css_t conf css js gif jpg py html bib") +set(EXT_FOR_DOC "rst png txt css_t conf css js gif jpg py html bib md") execute_process(COMMAND cp_rs ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} ${EXT_FOR_DOC}) # --------------------------------- diff --git a/doc/ChangeLog.md b/doc/ChangeLog.md new file mode 100644 index 00000000..0806d26b --- /dev/null +++ b/doc/ChangeLog.md @@ -0,0 +1,7 @@ +Version 0.1 +----------- + +Some Changes +~~~~~~~~~~~~ + +* ... diff --git a/doc/changelog.rst b/doc/changelog.rst new file mode 100644 index 00000000..7c169e86 --- /dev/null +++ b/doc/changelog.rst @@ -0,0 +1,8 @@ +.. _changelog: + +Changelog +========= + +This document describes the main changes in APP4TRIQS. + +.. include:: ChangeLog.md diff --git a/doc/conf.py.in b/doc/conf.py.in index 195e871d..d93c0c0b 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -13,8 +13,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', 'plot_directive', - 'numpydoc', - 'matplotlib.sphinxext.plot_directive'] + 'numpydoc'] source_suffix = '.rst' diff --git a/doc/index.rst b/doc/index.rst index d342e1ad..b4cd7805 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,6 +3,11 @@ app4triqs ========= +.. sidebar:: app4triqs 0.1 + + This is the homepage app4triqs Version 0.1 + For the changes in 0.1, Cf :ref:`changelog page ` + An example application using cpp2py and triqs. This documentation is generated based on `rst `_ files