From 2a8207398df4801c6a8210ddc9f68ee7b78fd485 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com> Date: Thu, 10 Dec 2020 15:31:53 +0100 Subject: [PATCH] DOC: add README_SETUP to doc --- README_SETUP.md | 26 ++++++++++++++------------ src/doc/conf.py | 2 +- src/doc/index.rst | 4 ++-- 3 files changed, 17 insertions(+), 15 deletions(-) diff --git a/README_SETUP.md b/README_SETUP.md index 6fb59c34..8a2cd006 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -21,12 +21,14 @@ * ** 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 `test` folder contains the unittests for the webinterface. -* The `ext` folder contains extension for the webinterface. The make file will +* The `test` folder contains the unittests for the web interface. +* 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 javascript in the `public/xsl/main.xsl`. * The `misc` folder contains a simple http server which is used for running the @@ -34,7 +36,7 @@ * The `build.properties.d/` folder contains configuration files for the build. -# Build Configuration +## Build Configuration The default configuration is defined in `build.properties.d/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 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. * 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 server as server-side scripts you need to include the `sss_bin/` directory 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. * Run `make run-test-server` to start a python http server. * The test suite can be started with `firefox http://localhost:8000/`. -# Clean +## Clean * Run `make clean` to clean up everything. -# Documentation # +## Documentation # Build documentation in `build/` with `make doc`. -## Requirements ## +### Requirements ## - sphinx - sphinx-autoapi diff --git a/src/doc/conf.py b/src/doc/conf.py index 94dbaf66..4695f202 100644 --- a/src/doc/conf.py +++ b/src/doc/conf.py @@ -95,7 +95,7 @@ html_theme = "sphinx_rtd_theme" # 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, # 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 # to template names. diff --git a/src/doc/index.rst b/src/doc/index.rst index 9c1f07e6..5f04cf01 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -7,14 +7,14 @@ Welcome to caosdb-server's documentation! :caption: Contents: :hidden: - Getting started <getting_started> + Getting started <README_SETUP> Concepts <concepts> tutorials API documentation<autoapi> 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>`. .. note:: -- GitLab