LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-07-11 05:43:48 +02:00
Code Issues Releases Wiki Activity

[doc] Fix few doc problems, add changelog

Browse Source
This commit is contained in:
Nils Wentzell 2018-06-03 22:28:24 -04:00
parent 04d7aef339
commit 4a7ffbdf92
6 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ChangeLog.md Symbolic link
View File

@ -0,0 +1 @@
doc/ChangeLog.md

2
doc/CMakeLists.txt
View File

@ -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})
# ---------------------------------

7
doc/ChangeLog.md Normal file
View File

@ -0,0 +1,7 @@
Version 0.1
-----------
Some Changes
~~~~~~~~~~~~
* ...

8
doc/changelog.rst Normal file
View File

@ -0,0 +1,8 @@
.. _changelog:
Changelog
=========
This document describes the main changes in APP4TRIQS.
.. include:: ChangeLog.md

3
doc/conf.py.in
View File

@ -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'

5
doc/index.rst
View File

@ -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 <changelog>`
An example application using cpp2py and triqs.
This documentation is generated based on `rst <https://de.wikipedia.org/wiki/ReStructuredText>`_ files