Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-pylib
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-pylib
Commits
64aae359
Commit
64aae359
authored
2 years ago
by
Henrik tom Wörden
Browse files
Options
Downloads
Patches
Plain Diff
DOC: how to contribute to doc
parent
ae3f5599
No related branches found
Branches containing commit
No related tags found
Tags containing commit
2 merge requests
!93
Release 0.11.0
,
!78
F how to doc
Pipeline
#30461
passed
2 years ago
Stage: code_style
Stage: linting
Stage: test
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README_SETUP.md
+8
-0
8 additions, 0 deletions
README_SETUP.md
with
8 additions
and
0 deletions
README_SETUP.md
+
8
−
0
View file @
64aae359
...
...
@@ -109,6 +109,8 @@ Now would be a good time to continue with the [tutorials](tutorials/index).
-
Run a specific test function: e.g.
`tox -- unittests/test_schema.py::test_config_files`
## Documentation ##
We use sphinx to create the documentation. Docstrings in the code should comply
with the Googly style (see link below).
Build documentation in
`build/`
with
`make doc`
.
...
...
@@ -118,5 +120,11 @@ Build documentation in `build/` with `make doc`.
-
`sphinx-autoapi`
-
`recommonmark`
### How to contribute ###
-
[
Google Style Python Docstrings
](
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
)
-
[
Google Style Python Docstrings 2nd reference
](
https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
)
-
[
References to other documentation
](
https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external
)
### Troubleshooting ###
If the client is to be executed directly from the
`/src`
folder, an initial
`.\setup.py install --user`
must be called.
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