Skip to content
Snippets Groups Projects
Unverified Commit e6c73152 authored by Daniel's avatar Daniel
Browse files

FIX: Better links in TOC, renamed files.

parent de775417
No related branches found
No related tags found
No related merge requests found
../../README_SETUP.md
\ No newline at end of file
.. This file is a placeholder and will be replaced.
Index
=====
# Getting started with pycaosdb #
1. Install
2. import
3. enjoy
../../README_SETUP.md
\ No newline at end of file
Welcome to caosdb-webui's documentation! Welcome to the documentation of CaosDB's web UI!
========================================= ================================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
:hidden: :hidden:
Getting started <README_SETUP> Getting started <getting_started>
Concepts <concepts> Concepts <concepts>
tutorials tutorials
API documentation<autoapi> API Index<genindex>
This documentation helps you to :doc:`get started<README_SETUP>`, explains the most important
This documentation helps you to :doc:`get started<getting_started>`, explains the most important
:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`. :doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`.
.. note:: .. note::
TODO: Build the index (manually?) like here: https://github.com/mozilla/fathom/edit/master/docs/ TODO: Build the index (manually?) like here: https://github.com/mozilla/fathom/edit/master/docs/.
Note that :doc:`autoapi/index` still does not have any content.
.. js:autofunction:: input2caosdbDate .. js:autofunction:: input2caosdbDate
...@@ -29,5 +31,4 @@ Indices and tables ...@@ -29,5 +31,4 @@ Indices and tables
================== ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex`
* :ref:`search` * :ref:`search`
...@@ -4,7 +4,6 @@ RUN echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/so ...@@ -4,7 +4,6 @@ RUN echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/so
&& apt-get install -y \ && apt-get install -y \
firefox-esr gettext-base pylint3 python3-pip \ firefox-esr gettext-base pylint3 python3-pip \
python3-httpbin git curl x11-apps xvfb unzip python3-pytest \ python3-httpbin git curl x11-apps xvfb unzip python3-pytest \
python3-recommonmark \
&& apt-get install -y -t buster-backports \ && apt-get install -y -t buster-backports \
npm npm
...@@ -13,4 +12,4 @@ RUN pip3 install pandas xlrd ...@@ -13,4 +12,4 @@ RUN pip3 install pandas xlrd
RUN pip3 install git+https://gitlab.com/caosdb/caosdb-advanced-user-tools.git@dev RUN pip3 install git+https://gitlab.com/caosdb/caosdb-advanced-user-tools.git@dev
# For automatic documentation # For automatic documentation
RUN npm install -g jsdoc RUN npm install -g jsdoc
RUN pip3 install sphinx-js sphinx-autoapi sphinx-rtd-theme RUN pip3 install sphinx-js sphinx-autoapi recommonmark sphinx-rtd-theme
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment