Commit 7da64d64 authored by Cyril Guilloud's avatar Cyril Guilloud

Merge branch '1040-prompt-invite-prevent-copy-paste-from-documentation' into 'master'

Resolve "Prompt invite prevent copy/paste from documentation"

Closes #1040

See merge request !1613
parents b82127dc 0a9c6c73
Pipeline #15395 passed with stages
in 47 minutes and 30 seconds
......@@ -25,11 +25,11 @@ daemons started by the system:
It is required to start Beacon server using `--db-path` to specify the path to the configuration files:
$ beacon-server --db-path=~/local/beamline_configuration
beacon-server --db-path=~/local/beamline_configuration
Beacon port number can be set manually (otherwise, by default, Beacon will just choose the first free port it finds):
$ beacon-server --db-path=~/local/beamline_configuration --port=25000
beacon-server --db-path=~/local/beamline_configuration --port=25000
!!! note
Beacon implements a discovery protocol (in the same spirit as [SSDP](https://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol)).
......@@ -39,13 +39,13 @@ Beacon port number can be set manually (otherwise, by default, Beacon will just
The web configuration UI can be enabled, by specifying the web application port number using `--webapp-port`:
$ beacon-server --db-path=~/local/beamline_configuration --port=25000 --webapp-port=9030
beacon-server --db-path=~/local/beamline_configuration --port=25000 --webapp-port=9030
BLISS Beacon server is also able to provide a full TANGO database server service that integrates nicely
with the BLISS configuration. To start this service it is just needed to provide the TANGO port that
you want the TANGO database server to serve:
$ beacon-server --db-path=~/local/beamline_configuration --port=25000 --webapp-port=9030 --tango-port=20000
beacon-server --db-path=~/local/beamline_configuration --port=25000 --webapp-port=9030 --tango-port=20000
## Command line options
......
......@@ -10,7 +10,7 @@
### Listening to a Bliss session
When running the script
$ python scripts/external_saving_example/external_saving_example.py
python scripts/external_saving_example/external_saving_example.py
it is listening to new scans in the Bliss __test_session__
......@@ -93,6 +93,6 @@ In order to have some test cases for more demanding scans when working with the
The same scans can also be executed using Bliss in a library mode running (_TANGO_HOST_ to be chosen according to the running server...)
```bash
$ BEACON_HOST=localhost TANGO_HOST=localhost:20000 python scripts/external_saving_example/some_scans_bliss_as_library.py
BEACON_HOST=localhost TANGO_HOST=localhost:20000 python scripts/external_saving_example/some_scans_bliss_as_library.py
```
......@@ -26,14 +26,14 @@ in a conda environment.
!!! note "At ESRF"
At ESRF, enter the BLISS development conda environment to install documentation requirements:
```bash
$ . blissenv -d
. blissenv -d
```
```bash
$ cd <bliss.git directory>
$ conda install --file requirements-doc-conda.txt
$ pip install -r requirements-doc.txt
cd <bliss.git directory>
conda install --file requirements-doc-conda.txt
pip install -r requirements-doc.txt
```
This installs `mkdocs` and all dependencies.
......@@ -41,8 +41,8 @@ This installs `mkdocs` and all dependencies.
In order to serve a local version of the documentation, start
the mkdocs serve with:
```bash
$ cd <bliss.git directory>/doc/
$ mkdocs serve
cd <bliss.git directory>/doc/
mkdocs serve
```
And visit http://localhost:8000
......@@ -52,8 +52,8 @@ http://localhost:8000/dev_documentation.html
Please do the following
```bash
$ cd <bliss.git directory>/doc/docs
$ <your favorite editor> dev_documentation.md
cd <bliss.git directory>/doc/docs
<your favorite editor> dev_documentation.md
```
Once you save **dev_documentation.md** you can see the new version
......@@ -141,22 +141,22 @@ To easily view the result of your writing, using a local rendering:
!!! note "At ESRF"
At ESRF, enter the BLISS development conda environment to install documentation requirements:
```bash
$ . blissenv -d
. blissenv -d
```
```bash
$ cd <bliss.git directory>
$ conda install --file requirements-doc-conda.txt
$ pip install -r requirements-doc.txt
cd <bliss.git directory>
conda install --file requirements-doc-conda.txt
pip install -r requirements-doc.txt
```
* launch `mkdocs` in server mode in your conda environment:
```bash
$ hostname
hostname
myhost
$ cd <bliss.git directory>/doc/
$ mkdocs serve -a myhost:8888
cd <bliss.git directory>/doc/
mkdocs serve -a myhost:8888
```
* and visit [http://myhost:8888](http://myhost:888) to see the documentation
......
......@@ -6,11 +6,11 @@ The BLISS project is hosted on the [ESRF Gitlab](https://gitlab.esrf.fr/bliss/bl
To clone bliss:
```
$ git clone https://gitlab.esrf.fr/bliss/bliss.git
git clone https://gitlab.esrf.fr/bliss/bliss.git
```
The first thing to do after cloning bliss is to set up the pre-commit hook:
```
$ ./pre-commit.sh
./pre-commit.sh
pre-commit installed at /home/user/bliss/.git/hooks/pre-commit
```
......@@ -21,7 +21,7 @@ code style in the project. For more information, see the
Bliss has some dependencies on third-party software. The complete list
of dependencies can be obtained from the `setup.py` script:
```
$ python setup.py egg_info
python setup.py egg_info
```
(see `bliss.egg_info/requirements.txt`).
......@@ -70,7 +70,7 @@ from Alibaba Inc, in their experiments.
* She clones the Bliss repository and creates a new branch
called *alibaba\_pressure\_meter*:
```
$ git checkout -b alibaba_pressure_meter
git checkout -b alibaba_pressure_meter
```
* She is a fan of [TDD](https://en.wikipedia.org/wiki/Test-driven_development), so
she starts thinking how she would like to control the device and
......@@ -139,16 +139,16 @@ There is 3 complementary ways to work with black:
* Run it using the command line interface:
```
$ pip3 install black
pip3 install black
[...]
$ black .
black .
All done! ✨ 🍰 ✨
466 files left unchanged.
```
* Let the pre-commit hook format your changes. Make sure it is properly set up by running:
```
$ ./pre-commit
./pre-commit
```
!!! note
......@@ -157,7 +157,7 @@ $ ./pre-commit
before re-applying the commit:
```bash
$ git commit demo.py -m "Some message"
git commit demo.py -m "Some message"
black..........................................................Failed
Files were modified by this hook. Additional output:
reformatted doc/demo.py
......@@ -166,7 +166,7 @@ $ ./pre-commit
[WARNING] Stashed changes conflicted with hook auto-fixes...
Rolling back fixes...
$ git commit demo.py -m "Some message"
git commit demo.py -m "Some message"
black..........................................................Passed
[branch 89b740f2] Some message
1 file changed, 1 insertion(+)
......
......@@ -34,7 +34,7 @@ or specific experiment).
```
$ bliss -s eh1
bliss -s eh1
```
```python
......@@ -555,7 +555,7 @@ require anything from the host Python program.
For example a BLISS-friendly IPython console can be started like this:
$ python -c "import gevent.monkey; gevent.monkey.patch_all(thread=False); import IPython; IPython.start_ipython()"
python -c "import gevent.monkey; gevent.monkey.patch_all(thread=False); import IPython; IPython.start_ipython()"
The line above launches Python, makes sure Python standard library is
patched, without replacing system threads by gevent greenlets (which
......
......@@ -43,10 +43,10 @@ For development, i.e in `bliss_env` Conda environement:
needed:
```bash
$ conda config --env --add channels esrf-bcu
$ conda config --env --append channels conda-forge
$ conda config --env --append channels tango-controls
$ conda config --env --append channels http://bcu-ci.esrf.fr/stable
conda config --env --add channels esrf-bcu
conda config --env --append channels conda-forge
conda config --env --append channels tango-controls
conda config --env --append channels http://bcu-ci.esrf.fr/stable
```
......@@ -135,7 +135,7 @@ pip install .
For development, install with:
`$ pip install -e .`
`pip install -e .`
The code will get deployed in Python **site-packages** directory as a symbolic link,
thus removing the need to re-install each time a modification is made.
......@@ -153,19 +153,19 @@ an existing conda env. in which BLISS is installed.
2) Install additional dependencies for the test environment
$ conda install --file ./requirements-test-conda.txt
conda install --file ./requirements-test-conda.txt
3) start a BEACON server using the provided _test_configuration_ (path relative to root of bliss repository)
$ beacon-server --db_path tests/test_configuration/ --tango_port 20000
beacon-server --db_path tests/test_configuration/ --tango_port 20000
4) to simulate a lima camera run also
$ TANGO_HOST=localhost:20000 LimaCCDs simulator
TANGO_HOST=localhost:20000 LimaCCDs simulator
5) start a BLISS test_session
$ BEACON_HOST=localhost TANGO_HOST=localhost:20000 bliss -s test_session
BEACON_HOST=localhost TANGO_HOST=localhost:20000 bliss -s test_session
and enjoy or have a look at the following doc sections:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment