Verified Commit caf97a6e authored by Alberto Miranda's avatar Alberto Miranda ♨️
Browse files

Migrate wiki documentation to new format

parent a71bb68f

docker/0.8.0/docs/Dockerfile

+6 −3
Original line number Diff line number Diff line
@@ -18,10 +18,13 @@ RUN apt-get update && \ 
	make -j8 install && \

    # install sphinx, breathe and exhale

    pip3 install \

        'sphinx==4.0.2' \

        'sphinx==4.4.0' \

        sphinx_rtd_theme \

        'breathe==4.30.0' \

        'exhale==0.2.3' && \

        'breathe==4.31.0' \

        'exhale==0.2.4' \

        'sphinx-copybutton==0.4.0' \

        'sphinx-multiversion==0.2.4' \

        'myst_parser==0.15.1' && \

    # Clean apt cache to reduce image layer size

    rm -rf /var/lib/apt/lists/* && \

    rm -rf /tmp/doxygen-1.9.2 && \

docs/sphinx/_templates/layout.html

0 → 100644
+16 −0
Original line number Diff line number Diff line 
{%- extends "!layout.html" %}

    {%- block htmltitle %}

    {% if versions %}

    <title>{{ title|striptags|e }} - {{ project }} {{ current_version.name }} Documentation</title>

    {% else %}

     <title>{{ title|striptags|e }}{{ titlesuffix }}</title>

    {% endif %}

    {%- endblock %}



 {%- block rootrellink %}

 {% if versions %}

 <li class="nav-item nav-item-0"><a href="{{ pathto(master_doc)|e }}">{{ project }} {{ current_version.name }} Documentation</a>{{ reldelim1 }}</li>

 {% else %}

 <li class="nav-item nav-item-0"><a href="{{ pathto(master_doc)|e }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>

 {% endif %}

{%- endblock %}

docs/sphinx/_templates/versions.html

0 → 100644
+27 −0
Original line number Diff line number Diff line 
{%- if current_version %}

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">

  <span class="rst-current-version" data-toggle="rst-current-version">

    <span class="fa fa-book"> Other Versions</span>

    v: {{ current_version.name }}

    <span class="fa fa-caret-down"></span>

  </span>

  <div class="rst-other-versions">

    {%- if versions.tags %}

    <dl>

      <dt>Tags</dt>

      {%- for item in versions.tags %}

      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>

      {%- endfor %}

    </dl>

    {%- endif %}

    {%- if versions.branches %}

    <dl>

      <dt>Branches</dt>

      {%- for item in versions.branches %}

      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>

      {%- endfor %}

    </dl>

    {%- endif %}

  </div>

</div>

{%- endif %}

docs/sphinx/conf.py.in

+5 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ 
# -- Project information -----------------------------------------------------



project = 'GekkoFS'

copyright = ['2018-2021, Barcelona Supercomputing Center, Spain', '2015-2021, Johannes Gutenberg Universitaet Mainz, Germany' ]

copyright = ['2018-2022, Barcelona Supercomputing Center, Spain', '2015-2022, Johannes Gutenberg Universitaet Mainz, Germany' ]

author = 'GekkoFS committers'



# The short X.Y version
@@ -40,6 +40,9 @@ highlight_language = 'cpp' 
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = [

    'sphinx_copybutton',

    'sphinx_multiversion',

    'myst_parser',

    @SPHINX_EXTENSIONS@

]
@@ -80,3 +83,4 @@ html_static_path = ['_static'] 




# -- Extension configuration -------------------------------------------------

copybutton_prompt_text = '$ '

docs/sphinx/devs/docs.rst

deleted100644 → 0
+0 −9
Original line number Diff line number Diff line 
============================

Documentation for developers

============================



This page summarizes documents for GekkoFS developers and advanced users.



.. toctree::

   :maxdepth: 2

   :caption: Doxygen documentation