Skip to content
Snippets Groups Projects
Verified Commit b10cd532 authored by Daniel Hornung's avatar Daniel Hornung
Browse files

DOC: Better intro to documentation, renamed "Getting started".

parent 9f04f538
Branches
Tags
1 merge request!103Quick main-release of documentation
Pipeline #37011 passed
...@@ -20,10 +20,10 @@ ...@@ -20,10 +20,10 @@
* *
* ** end header * ** end header
--> -->
# Build and install the Web Interface
# Getting Started with the Web Interface
Here, we document how to install and build the CaosDB Web Interface. If you are Here, we document how to install and build the CaosDB Web Interface. If you are
only interested in how to use it, please continue [here](tutorials/first_steps.html) only interested in how to use it, please continue [here](tutorials/index).
## Folder Structure ## Folder Structure
...@@ -72,7 +72,7 @@ See `build.properties.d/00_default.properties` for more information. ...@@ -72,7 +72,7 @@ See `build.properties.d/00_default.properties` for more information.
* Run `make clean` to clean up everything. * Run `make clean` to clean up everything.
## Documentation # ## Build the documentation #
Build documentation in `build/` with `make doc`. Build documentation in `build/` with `make doc`.
......
...@@ -41,10 +41,10 @@ release = '0.10.2-SNAPSHOT' ...@@ -41,10 +41,10 @@ release = '0.10.2-SNAPSHOT'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
# 'sphinx_js', # 'sphinx_js',
'sphinx.ext.todo', 'sphinx.ext.todo',
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
# 'autoapi.extension', # 'autoapi.extension',
"recommonmark", # For markdown files. "recommonmark", # For markdown files.
"sphinx_rtd_theme", "sphinx_rtd_theme",
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
...@@ -70,7 +70,7 @@ master_doc = 'index' ...@@ -70,7 +70,7 @@ master_doc = 'index'
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = "en"
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
......
...@@ -7,16 +7,20 @@ Welcome to the documentation of CaosDB's web UI! ...@@ -7,16 +7,20 @@ Welcome to the documentation of CaosDB's web UI!
:caption: Contents: :caption: Contents:
:hidden: :hidden:
Getting started <getting_started> Manual installation <install>
Tutorials <tutorials/index> Tutorials <tutorials/index>
Concepts <concepts> Concepts <concepts>
administration/index.rst administration/index.rst
Extending the UI <extension> Extending the UI <extension>
API <api/index> API <api/index>
.. note::
This documentation helps you to :doc:`get started<getting_started>`, explains the most important Go to `demo.indiscale.com <https://demo.indiscale.com>`__ and take the interactive tour to learn
:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`. how to use LinkAhead's web interface.
This documentation helps you to :doc:`install the web UI <install>`, explains the most important
:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials/index>`.
Indices and tables Indices and tables
......
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment