Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-webui
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-webui
Commits
b10cd532
Verified
Commit
b10cd532
authored
2 years ago
by
Daniel Hornung
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Better intro to documentation, renamed "Getting started".
parent
9f04f538
Branches
Branches containing commit
Tags
Tags containing commit
1 merge request
!103
Quick main-release of documentation
Pipeline
#37011
passed
2 years ago
Stage: linting
Stage: test
Changes
4
Pipelines
7
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
README_SETUP.md
+3
-3
3 additions, 3 deletions
README_SETUP.md
src/doc/conf.py
+3
-3
3 additions, 3 deletions
src/doc/conf.py
src/doc/index.rst
+7
-3
7 additions, 3 deletions
src/doc/index.rst
src/doc/install.md
+0
-0
0 additions, 0 deletions
src/doc/install.md
with
13 additions
and
9 deletions
README_SETUP.md
+
3
−
3
View file @
b10cd532
...
@@ -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.
##
D
ocumentation #
##
Build the d
ocumentation #
Build documentation in
`build/`
with
`make doc`
.
Build documentation in
`build/`
with
`make doc`
.
...
...
This diff is collapsed.
Click to expand it.
src/doc/conf.py
+
3
−
3
View file @
b10cd532
...
@@ -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.
...
...
This diff is collapsed.
Click to expand it.
src/doc/index.rst
+
7
−
3
View file @
b10cd532
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
src/doc/
getting_started
.md
→
src/doc/
install
.md
+
0
−
0
View file @
b10cd532
File moved
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment