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
2a820739
Commit
2a820739
authored
4 years ago
by
Henrik tom Wörden
Browse files
Options
Downloads
Patches
Plain Diff
DOC: add README_SETUP to doc
parent
8f1ab3b0
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
README_SETUP.md
+14
-12
14 additions, 12 deletions
README_SETUP.md
src/doc/conf.py
+1
-1
1 addition, 1 deletion
src/doc/conf.py
src/doc/index.rst
+2
-2
2 additions, 2 deletions
src/doc/index.rst
with
17 additions
and
15 deletions
README_SETUP.md
+
14
−
12
View file @
2a820739
...
@@ -21,12 +21,14 @@
...
@@ -21,12 +21,14 @@
*
**
end header
*
**
end header
-->
-->
#
Folder Structure
#
Getting Started with the Web Interface
*
The
`src`
folder contains all source code for the webinterface.
## Folder Structure
*
The
`src`
folder contains all source code for the web interface.
*
The
`libs`
folder contains all necessary third-party libraries as zip files.
*
The
`libs`
folder contains all necessary third-party libraries as zip files.
*
The
`test`
folder contains the unittests for the webinterface.
*
The
`test`
folder contains the unittests for the web
interface.
*
The
`ext`
folder contains extension for the webinterface. The make file will
*
The
`ext`
folder contains extension for the web
interface. The make file will
copy all javascript files from
`ext/js/`
into the public folder and links the
copy all javascript files from
`ext/js/`
into the public folder and links the
javascript in the
`public/xsl/main.xsl`
.
javascript in the
`public/xsl/main.xsl`
.
*
The
`misc`
folder contains a simple http server which is used for running the
*
The
`misc`
folder contains a simple http server which is used for running the
...
@@ -34,7 +36,7 @@
...
@@ -34,7 +36,7 @@
*
The
`build.properties.d/`
folder contains configuration files for the build.
*
The
`build.properties.d/`
folder contains configuration files for the build.
# Build Configuration
#
# Build Configuration
The default configuration is defined in
The default configuration is defined in
`build.properties.d/00_default.properties`
.
`build.properties.d/00_default.properties`
.
...
@@ -49,31 +51,31 @@ files in there which override the default values from `00_default.properties`.
...
@@ -49,31 +51,31 @@ files in there which override the default values from `00_default.properties`.
See
`build.properties.d/00_default.properties`
for more
See
`build.properties.d/00_default.properties`
for more
information.
information.
# Setup
#
# Setup
*
Run
`make install`
to compile/copy the webinterface to a newly created
*
Run
`make install`
to compile/copy the web
interface to a newly created
`public`
folder.
`public`
folder.
*
Also,
`make install`
will copy the scripts from
`src/server_side_scripting/`
*
Also,
`make install`
will copy the scripts from
`src/server_side_scripting/`
to
`sss_bin/`
. If you want to make the server-side scripts callable for the
to
`sss_bin/`
. If you want to make the server-side scripts callable for the
server as server-side scripts you need to include the
`sss_bin/`
directory
server as server-side scripts you need to include the
`sss_bin/`
directory
into the server property
`SERVER_SIDE_SCRIPTING_BIN_DIRS`
.
into the server property
`SERVER_SIDE_SCRIPTING_BIN_DIRS`
.
# Test
#
# Test
*
Run
`make test`
to compile/copy the webinterface and the tests to a newly
*
Run
`make test`
to compile/copy the web
interface and the tests to a newly
created
`public`
folder.
created
`public`
folder.
*
Run
`make run-test-server`
to start a python http server.
*
Run
`make run-test-server`
to start a python http server.
*
The test suite can be started with
`firefox http://localhost:8000/`
.
*
The test suite can be started with
`firefox http://localhost:8000/`
.
# Clean
#
# Clean
*
Run
`make clean`
to clean up everything.
*
Run
`make clean`
to clean up everything.
# Documentation #
#
# Documentation #
Build documentation in
`build/`
with
`make doc`
.
Build documentation in
`build/`
with
`make doc`
.
## Requirements ##
##
#
Requirements ##
-
sphinx
-
sphinx
-
sphinx-autoapi
-
sphinx-autoapi
...
...
This diff is collapsed.
Click to expand it.
src/doc/conf.py
+
1
−
1
View file @
2a820739
...
@@ -95,7 +95,7 @@ html_theme = "sphinx_rtd_theme"
...
@@ -95,7 +95,7 @@ html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path
=
[
'
_static
'
]
#
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
# to template names.
...
...
This diff is collapsed.
Click to expand it.
src/doc/index.rst
+
2
−
2
View file @
2a820739
...
@@ -7,14 +7,14 @@ Welcome to caosdb-server's documentation!
...
@@ -7,14 +7,14 @@ Welcome to caosdb-server's documentation!
:caption: Contents:
:caption: Contents:
:hidden:
:hidden:
Getting started <
getting_started
>
Getting started <
README_SETUP
>
Concepts <concepts>
Concepts <concepts>
tutorials
tutorials
API documentation<autoapi>
API documentation<autoapi>
Welcome to the WebUI for CaosDB, ``pycaosdb``!
Welcome to the WebUI for CaosDB, ``pycaosdb``!
This documentation helps you to :doc:`get started<
getting_started
>`, explains the most important
This documentation helps you to :doc:`get started<
README_SETUP
>`, 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::
...
...
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