Skip to content
This repository was archived by the owner on Aug 4, 2023. It is now read-only.

Commit 50af124

Browse files
fixed pdoc linking issues in documentation
1 parent d821eca commit 50af124

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

gcip/__init__.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
* addons
1111
1212
The **core** folder contains, as the name implies, all the core components that represent Gitlab CI objects in Python.
13-
You need to know that all class names from all Python modules within the _core_ folder are mapped to the gcip
14-
root module. This is done within the `__init__.py` of the gcip folder. Instead of _import gcip.core.job.Job_
15-
you should _import gcip.Job_. You should import all classes of the _core_ folder the same way.
13+
You need to know that all class names from all Python modules within the ```core``` folder are mapped to the gcip
14+
root module. This is done within the ```__init__.py``` of the gcip folder. Instead of ```import gcip.core.job.Job```
15+
you should ```import gcip.Job```. You should import all classes of the ```core``` folder the same way.
1616
1717
Always remember:
1818
@@ -30,13 +30,13 @@
3030
pipeline = pipeline.Pipeline()
3131
```
3232
33-
The **lib** folder contains all higher level objects which are derived from the _core_ objects. For example: `gcip.Rule`
34-
from _gcip.core.rule_ is the general Gitlab CI Rule representation, whereas _core.rules_ contains some convenient
35-
predefined Rule instances like `on_main()` or `on_tags()`.
33+
The **lib** folder contains all higher level objects which are derived from the ```core``` objects. For example: `gcip.Rule`
34+
from _gcip.core.rule_ is the general Gitlab CI Rule representation, whereas ```core.rules``` contains some convenient
35+
predefined Rule instances like ```on_main()``` or ```on_tags()```.
3636
3737
The **tools** folder contains all code which is used by the library code but does not represent any Gitlab CI specific
3838
functionality. This directory also contains scripts which could be run on their own and are supposed to be called
39-
by Gitlab CI jobs during the pipeline execution. For example _gcip.tools.url.is_valid_url(str)_ which, as the name implies,
39+
by Gitlab CI jobs during the pipeline execution. For example ```gcip.tools.url.is_valid_url(str)``` which, as the name implies,
4040
checks if `str` is a valid url.
4141
4242
The **addons** folder also contains code which extends the core components in form of higher level objects that provide
@@ -49,10 +49,10 @@
4949
5050
We also use a following naming conventions throughout the library:
5151
52-
* Files called _job_scripts.py_ hold functions that return strings, which could be used as command within
52+
* Files called ```_job_scripts.py``` hold functions that return strings, which could be used as command within
5353
Gitlab CI jobs.
5454
* Directories called _tools_ hold Python scripts which could be called by Gitlab CI jobs during the pipeline
55-
execution. They will be called directly from the Gitlab CI Python library, e.g. `python3 -m gcip.path.to.script`.
55+
execution. They will be called directly from the Gitlab CI Python library, e.g. ```python3 -m gcip.path.to.script```.
5656
"""
5757

5858
from pkg_resources import (

0 commit comments

Comments
 (0)