Skip to content

Commit 09b6610

Browse files
author
David Erb
committed
devops 0.5.3
1 parent 8639728 commit 09b6610

24 files changed

+90
-74
lines changed

‎.dae-devops/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ********** Please don't edit this file!
2-
# ********** It has been generated automatically by dae_devops version 0.5.3.
2+
# ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
# ********** For repository_name dls-servbase
44

55
# ---------------------------------------------------------------------
@@ -69,4 +69,4 @@ publish_docs:
6969
cp -r build/html/* $(DOCS_PUBLISH_ROOT)
7070

7171

72-
# dae_devops_fingerprint 7a40fdc6afce4991715aeda7ae70c444
72+
# dae_devops_fingerprint 2d453caef2662f6d4cfd06d459312f02

‎.dae-devops/docs/conventions.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. # ********** Please don't edit this file!
2-
.. # ********** It has been generated automatically by dae_devops version 0.5.3.
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
.. # ********** For repository_name dls-servbase
44
55
Naming conventions
@@ -31,4 +31,4 @@ repository
3131
lowercase, hyphens
3232

3333

34-
.. # dae_devops_fingerprint cbd0a78343b6577aa4ddb9d59a242b04
34+
.. # dae_devops_fingerprint 377aec0d2a3859ddaaadcf7d54438742

‎.dae-devops/docs/developing.rst‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. # ********** Please don't edit this file!
2-
.. # ********** It has been generated automatically by dae_devops version 0.5.3.
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
.. # ********** For repository_name dls-servbase
44
55
Developing
@@ -9,11 +9,12 @@ If you plan to make change to the code in this repository, you can use the steps
99

1010
Clone the repository::
1111

12+
$ cd <your development area>
1213
$ git clone https://gitlab.diamond.ac.uk/kbp43231/dls-servbase.git
1314

1415
It is recommended that you install into a virtual environment so this
1516
installation will not interfere with any existing Python software.
16-
Make sure to have at least python version 3.9 then::
17+
Make sure to have at least python version 3.10 then::
1718

1819
$ python3 -m venv /scratch/$USER/myvenv
1920
$ source /scratch/$USER/myvenv/bin/activate
@@ -22,17 +23,9 @@ Make sure to have at least python version 3.9 then::
2223
Install the package in edit mode which will also install all its dependencies::
2324

2425
$ cd dls-servbase
25-
$ pip install -e .[dev]
26+
$ pip install -e .[dev,docs]
2627

2728
Now you may begin modifying the code.
2829

29-
|
3030

31-
If you plan to modify the docs, you will need to::
32-
33-
$ pip install -e .[docs]
34-
35-
36-
37-
38-
.. # dae_devops_fingerprint ac891cf352ef89b3b20d2c601dd9ddc4
31+
.. # dae_devops_fingerprint 0fd7e3e20b23c566fad722262ab9f97a

‎.dae-devops/docs/devops.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. # ********** Please don't edit this file!
2-
.. # ********** It has been generated automatically by dae_devops version 0.5.3.
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
.. # ********** For repository_name dls-servbase
44
55
Devops
@@ -44,4 +44,4 @@ Publishing (for the Diamond intranet)::
4444
4545
The Diamond intranet commands are not used for production. The production packaging and publishing are handled in the GitHub Actions workflows mechanism.
4646

47-
.. # dae_devops_fingerprint 84e8a32100211cbba64804a3e5c5b337
47+
.. # dae_devops_fingerprint e8dff03fd491f40bda262817af6bf646

‎.dae-devops/docs/docs_structure.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. # ********** Please don't edit this file!
2-
.. # ********** It has been generated automatically by dae_devops version 0.5.3.
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
.. # ********** For repository_name dls-servbase
44
55
About the documentation
@@ -21,4 +21,4 @@ improve most documentation - often immensely.
2121

2222
`More information on this topic. <https://documentation.divio.com>`_
2323

24-
.. # dae_devops_fingerprint 6ef08be920f12050c1c579cf6e9d4253
24+
.. # dae_devops_fingerprint 505d623863ca025fcddb20fe31db39d4

‎.dae-devops/docs/documenting.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. # ********** Please don't edit this file!
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
3+
.. # ********** For repository_name dls-servbase
4+
5+
Documenting
6+
=======================================================================
7+
8+
If you plan to make update the documentation in this repository, you can use the steps below.
9+
10+
First, follow the steps in the Developing section to get a copy of the source code and install its dependencies.
11+
12+
If you didn't do this already, make sure you have the documentation tools::
13+
14+
$ cd <your development area>/dls-servbase
15+
$ pip install -e .[docs]
16+
17+
To produce the documentation locally::
18+
19+
$ tox -q -e docs
20+
21+
This writes the html into local directory build/html. You can browse the local documentation by::
22+
23+
file:///<your development area>/dls-servbase/build/html/index.html
24+
25+
When you push either the main branch or a tag to GitHub, the documents are built and published automatically to this url::
26+
27+
https://diamondlightsource.github.io/dls-servbase/main/index.html
28+
29+
30+
.. # dae_devops_fingerprint 850546fd7c3118fca1955e370bee4fc6

‎.dae-devops/docs/installing.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
.. # ********** Please don't edit this file!
2-
.. # ********** It has been generated automatically by dae_devops version 0.5.3.
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
.. # ********** For repository_name dls-servbase
44
55
Installing
66
=======================================================================
77

88

9-
You will need python 3.9 or later.
9+
You will need python 3.10 or later.
1010

11-
On a Diamond Light Source internal computer, you can achieve Python 3.9 by::
11+
On a Diamond Light Source internal computer, you can achieve Python 3.10 by::
1212

13-
$ module load python/3.9
13+
$ module load python/3.10
1414

1515
You can check your version of python by typing into a terminal::
1616

@@ -24,19 +24,19 @@ installation will not interfere with any existing Python software::
2424
$ pip install --upgrade pip
2525

2626

27-
You can now use ``pip`` to install the library and its dependencies::
27+
You can now use ``pip`` to install the package and its dependencies::
2828

2929
$ python3 -m pip install dls-servbase
3030

31-
If you require a feature that is not currently released you can also install
31+
If you require a feature that is not currently released, you can also install
3232
from git::
3333

3434
$ python3 -m pip install git+https://gitlab.diamond.ac.uk/kbp43231/dls-servbase.git
3535

36-
The library should now be installed and the commandline should be available.
36+
The package should now be installed and the command line should be available.
3737
You can check the version that has been installed by typing::
3838

3939
$ dls-servbase --version
4040
$ dls-servbase --version-json
4141

42-
.. # dae_devops_fingerprint 64d7ae0dde8939e479b9c793df928d15
42+
.. # dae_devops_fingerprint f5c12f1646c65db4968cb1f7cc1306d0

‎.dae-devops/docs/testing.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. # ********** Please don't edit this file!
2-
.. # ********** It has been generated automatically by dae_devops version 0.5.3.
2+
.. # ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
.. # ********** For repository_name dls-servbase
44
55
Testing
@@ -23,12 +23,12 @@ If you want to see more output of the test while it's running you can do::
2323

2424
Each test will write files into its own directory::
2525

26-
/tmp/dls-servbase/tests/....
26+
/tmp/dls-servbase/tests/*
2727

2828
The tests clear their directory when they start, but not when they finish.
29-
This allows peeking in there to see what's been written by the test.
29+
This allows you to examine what's been written by the test.
3030

3131

3232

3333

34-
.. # dae_devops_fingerprint 3bd80bbd88306473a1ee98b988b17986
34+
.. # dae_devops_fingerprint 197b7a99ae5cd1520d710ad36ebd4236

‎.dae-devops/prepare_git_dependencies.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22

33
# ********** Please don't edit this file!
4-
# ********** It has been generated automatically by dae_devops version 0.5.3.
4+
# ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
55
# ********** For repository_name dls-servbase
66

77
me=${BASH_SOURCE}
@@ -13,4 +13,4 @@ function __install {
1313
}
1414

1515

16-
# dae_devops_fingerprint 663e11dbca4cdd5f84a218a64398a688
16+
# dae_devops_fingerprint a12ea0ce18dbb5ec2a10162f22bba2dd

‎.devcontainer/Dockerfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ********** Please don't edit this file!
2-
# ********** It has been generated automatically by dae_devops version 0.5.3.
2+
# ********** It has been generated automatically by dae_devops version 0.5.4.dev0+g1fb30ef.d20230527.
33
# ********** For repository_name dls-servbase
44

55
# This file is for use as a devcontainer and a runtime container
@@ -40,4 +40,4 @@ ENV PATH=/venv/bin:$PATH
4040
ENTRYPOINT ["dls-servbase"]
4141
CMD ["--version"]
4242

43-
# dae_devops_fingerprint 80986671f8602f6e4666f78f98141826
43+
# dae_devops_fingerprint 0534faa0b5641c6bf5a6865dc868c633

0 commit comments

Comments
 (0)