Skip to content

Commit 08c05a1

Browse files
Small modifications to the documentation structure
1 parent facb455 commit 08c05a1

30 files changed

+37
-15
lines changed

MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ recursive-include docs *.png
2525
recursive-include docs *.py
2626
recursive-include docs *.rst
2727
recursive-include docs *.svg
28+
recursive-include docs *.html
2829
recursive-include docs Makefile
2930
recursive-include misc *.py
3031
recursive-include misc *.rst

docs/_templates/navigation.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<h3>{{ _('Navigation') }}</h3>
2+
{{ toctree(maxdepth=-10, includehidden=theme_sidebar_includehidden, collapse=theme_sidebar_collapse) }}
3+
{% if theme_extra_nav_links %}
4+
<hr />
5+
<ul>
6+
{% for text, uri in theme_extra_nav_links.items() %}
7+
<li class="toctree-l1"><a href="{{ uri }}">{{ text }}</a></li>
8+
{% endfor %}
9+
</ul>
10+
{% endif %}

docs/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@
127127
'github_banner': True,
128128
'show_powered_by': False,
129129
'sidebar_collapse': True,
130+
'show_relbar_bottom': True,
130131
'extra_nav_links': {
131132
'invenio@GitHub': 'https://github.com/inveniosoftware/invenio',
132133
'invenio@PyPI': 'https://pypi.python.org/pypi/invenio/',

docs/documentation/how-to/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
Invenio is free software; you can redistribute it and/or modify it
66
under the terms of the MIT License; see LICENSE file for more details.
77

8-
How-to
9-
======
8+
How-to's
9+
========
1010

1111
.. toctree::
1212
:maxdepth: 2

docs/documentation/index.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,4 @@ Documentation
1717
main-concepts/index
1818
bundles/index
1919
how-to/index
20-
releases/index
21-
upgrading/index
22-
migrating
20+
life-cycle/index
+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
..
2+
This file is part of Invenio.
3+
Copyright (C) 2020 CERN.
4+
5+
Invenio is free software; you can redistribute it and/or modify it
6+
under the terms of the MIT License; see LICENSE file for more details.
7+
8+
Life cycle
9+
==========
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
14+
releases/index
15+
upgrading/index
16+
migrating
File renamed without changes.

docs/documentation/main-concepts/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Main concepts
1111
=============
1212

1313
.. toctree::
14-
:maxdepth: 2
14+
:maxdepth: 1
1515

1616
repository-structure
1717
understanding-data-models

docs/documentation/main-concepts/repository-structure.rst

+4-8
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,10 @@
1010
Repository structure
1111
====================
1212

13-
CHANGE ME PLEASE
14-
15-
Now that you have generated the skeleton of your repository via cookiecutter,
16-
bootstrapped your instance, run it and created a record, let's have a deep dive
17-
at the various files and folders that were generated and what they do.
18-
19-
The generated skeleton is our default recommendation, however you are
20-
completely free to adapt it as your see fit.
13+
This section describes the file structure of a standard invenio project.
14+
The cookiecutter generates this skeleton for you.
15+
Note that the following file structure is our default recommandation,
16+
however you are completely free to adapt it as your see fit.
2117

2218
Management scripts
2319
------------------

docs/getting-started/quickstart/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ Quickstart
1313
.. toctree::
1414
:maxdepth: 2
1515

16-
quickstart
16+
installation
1717
crud-operations
1818
final-steps

0 commit comments

Comments
 (0)