From e6c73152b507699f8a757bcee332269262b5a167 Mon Sep 17 00:00:00 2001 From: Daniel <daniel@harvey> Date: Fri, 11 Dec 2020 12:52:19 +0100 Subject: [PATCH] FIX: Better links in TOC, renamed files. --- src/doc/README_SETUP.md | 1 - src/doc/genindex.rst | 4 ++++ src/doc/getting_started.md | 6 +----- src/doc/index.rst | 15 ++++++++------- test/docker/Dockerfile | 3 +-- 5 files changed, 14 insertions(+), 15 deletions(-) delete mode 120000 src/doc/README_SETUP.md create mode 100644 src/doc/genindex.rst mode change 100644 => 120000 src/doc/getting_started.md diff --git a/src/doc/README_SETUP.md b/src/doc/README_SETUP.md deleted file mode 120000 index 88332e35..00000000 --- a/src/doc/README_SETUP.md +++ /dev/null @@ -1 +0,0 @@ -../../README_SETUP.md \ No newline at end of file diff --git a/src/doc/genindex.rst b/src/doc/genindex.rst new file mode 100644 index 00000000..48ab71fd --- /dev/null +++ b/src/doc/genindex.rst @@ -0,0 +1,4 @@ +.. This file is a placeholder and will be replaced. + +Index +===== diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md deleted file mode 100644 index 6805181e..00000000 --- a/src/doc/getting_started.md +++ /dev/null @@ -1,5 +0,0 @@ -# Getting started with pycaosdb # - -1. Install -2. import -3. enjoy diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md new file mode 120000 index 00000000..88332e35 --- /dev/null +++ b/src/doc/getting_started.md @@ -0,0 +1 @@ +../../README_SETUP.md \ No newline at end of file diff --git a/src/doc/index.rst b/src/doc/index.rst index 4c6c572a..b3a26c96 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -1,23 +1,25 @@ -Welcome to caosdb-webui's documentation! -========================================= +Welcome to the documentation of CaosDB's web UI! +================================================ .. toctree:: :maxdepth: 2 :caption: Contents: :hidden: - Getting started <README_SETUP> + Getting started <getting_started> Concepts <concepts> 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>`. .. 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 @@ -29,5 +31,4 @@ Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/test/docker/Dockerfile b/test/docker/Dockerfile index 35a3918e..7340ee5a 100644 --- a/test/docker/Dockerfile +++ b/test/docker/Dockerfile @@ -4,7 +4,6 @@ RUN echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/so && apt-get install -y \ firefox-esr gettext-base pylint3 python3-pip \ python3-httpbin git curl x11-apps xvfb unzip python3-pytest \ - python3-recommonmark \ && apt-get install -y -t buster-backports \ npm @@ -13,4 +12,4 @@ RUN pip3 install pandas xlrd RUN pip3 install git+https://gitlab.com/caosdb/caosdb-advanced-user-tools.git@dev # For automatic documentation 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 -- GitLab