diff --git a/src/libprs500/manual/conf.py b/src/libprs500/manual/conf.py index 416dbc9885..7d98f25538 100644 --- a/src/libprs500/manual/conf.py +++ b/src/libprs500/manual/conf.py @@ -27,7 +27,7 @@ import custom extensions = ['sphinx.ext.autodoc', 'custom'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['.templates'] +templates_path = ['templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -83,7 +83,7 @@ html_style = 'default.css' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['static'] +html_static_path = ['resources'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/src/libprs500/manual/index.rst b/src/libprs500/manual/index.rst index 03e93873d4..cec4638fd7 100644 --- a/src/libprs500/manual/index.rst +++ b/src/libprs500/manual/index.rst @@ -25,9 +25,9 @@ Sections gui news + cli/cli-index conversion metadata - cli/cli-index faq glossary diff --git a/src/libprs500/manual/resources/logo.png b/src/libprs500/manual/resources/logo.png new file mode 100644 index 0000000000..ee3f19baa6 Binary files /dev/null and b/src/libprs500/manual/resources/logo.png differ diff --git a/src/libprs500/manual/templates/layout.html b/src/libprs500/manual/templates/layout.html new file mode 100644 index 0000000000..8a1407b19b --- /dev/null +++ b/src/libprs500/manual/templates/layout.html @@ -0,0 +1,134 @@ +{%- include "macros.html" %} +{%- block doctype -%} + +{%- endblock %} +{%- macro relbar %} +{# this macro needs to stay in layout.html due to it containing blocks #} +
+

Navigation

+ +
+{%- endmacro %} + + + + {%- if builder != 'htmlhelp' %} + {%- set titlesuffix = " — " + project + " Documentation" %} + {%- endif %} + {{ title|striptags }}{{ titlesuffix }} + {%- if builder == 'web' %} + + {%- for link, type, title in page_links %} + + {%- endfor %} + {%- else %} + + + {%- endif %} + {%- if builder != 'htmlhelp' %} + + + + + {%- endif %} +{%- block rellinks %} + {%- if hasdoc('about') %} + + {%- endif %} + + + + {%- if hasdoc('copyright') %} + + {%- endif %} + + {%- if parents %} + + {%- endif %} + {%- if next %} + + {%- endif %} + {%- if prev %} + + {%- endif %} +{%- endblock %} +{%- block extrahead %}{% endblock %} + + + +{%- block beforerelbar %}{% endblock %} +{%- block relbar1 %}{{ relbar() }}{% endblock %} +{%- block afterrelbar %}{% endblock %} + +{%- block beforesidebar1 %}{% endblock %} +{%- block sidebar1 %}{# possible location for sidebar #}{% endblock %} +{%- block aftersidebar1 %}{% endblock %} + +{%- block beforedocument %}{% endblock %} +
+
+ {%- if builder != 'htmlhelp' %} +
+ {%- endif %} +
+ {% block body %}{% endblock %} +
+ {%- if builder != 'htmlhelp' %} +
+ {%- endif %} +
+{%- block afterdocument %}{% endblock %} + +{%- block beforesidebar2 %}{% endblock %} +{%- block sidebar2 %}{{ sidebar() }}{% endblock %} +{%- block aftersidebar2 %}{% endblock %} +
+
+ +{%- block relbar2 %}{{ relbar() }}{% endblock %} + +{%- block beforefooter %}{% endblock %} +{%- block footer %} +
+ {%- if hasdoc('copyright') %} + © Copyright {{ copyright }}. + {%- else %} + © Copyright {{ copyright }}. + {%- endif %} + {%- if last_updated %} + Last updated on {{ last_updated }}. + {%- endif %} +
+{%- endblock %} +{%- block afterfooter %}{% endblock %} + + diff --git a/src/libprs500/manual/templates/macros.html b/src/libprs500/manual/templates/macros.html new file mode 100644 index 0000000000..65e2dfa65b --- /dev/null +++ b/src/libprs500/manual/templates/macros.html @@ -0,0 +1,55 @@ +{%- macro sidebar %} + {%- if builder != 'htmlhelp' %} +
+
+ {% if display_toc %} +

Table Of Contents

+ {{ toc }} + {% endif %} + {%- if prev %} +

Previous topic

+

{{ prev.title }}

+ {%- endif %} + {%- if next %} +

Next topic

+

{{ next.title }}

+ {%- endif %} + {% if sourcename %} +

This Page

+ + {% endif %} + {% if customsidebar %} + {{ rendertemplate(customsidebar) }} + {% endif %} + {% if current_page_name != "search" %} +

{{ builder == 'web' and 'Keyword' or 'Quick' }} search

+
+ + + +
+ {% if builder == 'web' %} +

Enter a module, class or function name.

+ {% endif %} + {% endif %} +
+ + + logo
{{ project }} + +
+
+
+ {%- endif %} +{%- endmacro %} +