mirror of
https://github.com/f-droid/fdroidserver.git
synced 2025-09-13 14:32:28 +03:00
rewrite docstrings to match numpy style guide
This commit is contained in:
parent
660520e3e1
commit
d168b9c05b
7 changed files with 400 additions and 208 deletions
24
README.md
24
README.md
|
@ -84,10 +84,32 @@ RAM. These test scripts are in the root of the project, all starting
|
|||
with _jenkins-_ since they are run on https://jenkins.debian.net.
|
||||
|
||||
|
||||
## Translation
|
||||
### Translation
|
||||
|
||||
Everything can be translated. See
|
||||
[Translation and Localization](https://f-droid.org/docs/Translation_and_Localization)
|
||||
for more info.
|
||||
|
||||
[](https://hosted.weblate.org/engage/f-droid/?utm_source=widget)
|
||||
|
||||
|
||||
### Documentation
|
||||
|
||||
The API documentation based on the docstrings gets automatically published [here](http://fdroid.gitlab.io/fdroidserver/) on every commit on the `master` branch.
|
||||
|
||||
It can be built locally via
|
||||
|
||||
```bash
|
||||
pip install -e .[docs]
|
||||
cd docs
|
||||
sphinx-apidoc -o ./source ../fdroidserver -M -e
|
||||
sphinx-autogen -o generated source/*.rst
|
||||
make html
|
||||
```
|
||||
|
||||
To additionally lint the code call
|
||||
```bash
|
||||
pydocstyle fdroidserver --count
|
||||
```
|
||||
|
||||
When writing docstrings you should follow the [numpy style guide](https://numpydoc.readthedocs.io/en/latest/format.html).
|
Loading…
Add table
Add a link
Reference in a new issue