include README in docs

This commit is contained in:
ftg 2024-04-16 07:22:59 +02:00
parent 4f879bd8bb
commit 3ecf1a4042
7 changed files with 11 additions and 1 deletions

Binary file not shown.

Binary file not shown.

View File

@ -10,6 +10,8 @@ Welcome to nodestack's documentation!
This project is under active development.
.. mdinclude:: ../../README.md
Content:
--------

View File

@ -75,6 +75,11 @@
<p class="admonition-title">Note</p>
<p>This project is under active development.</p>
</div>
</section>
<section id="nodestack">
<h1>Nodestack<a class="headerlink" href="#nodestack" title="Link to this heading"></a></h1>
<p>Nodestack is a library that allows user to build structured trees of datas.</p>
<p>Project is under active development. Have a look at the repository for usage. Feel free to push patches.</p>
<section id="content">
<h2>Content:<a class="headerlink" href="#content" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">

File diff suppressed because one or more lines are too long

View File

@ -35,6 +35,7 @@ release = '0.1'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx_mdinclude',
'sphinx.ext.viewcode',
]

View File

@ -10,6 +10,8 @@ Welcome to nodestack's documentation!
This project is under active development.
.. mdinclude:: ../../README.md
Content:
--------