From d84f53b581e01ef7d21119806f01d0c1ee58fba4 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Tue, 15 Jan 2019 14:48:18 +0100
Subject: [PATCH] [doc] Improve API documentation and coverage
---
bob/devtools/bootstrap.py | 2 ++
bob/devtools/changelog.py | 1 +
bob/devtools/log.py | 2 +-
bob/devtools/release.py | 2 ++
doc/api.rst | 13 +++++++++++++
5 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/bob/devtools/bootstrap.py b/bob/devtools/bootstrap.py
index 8b38aced..5ea04ae9 100644
--- a/bob/devtools/bootstrap.py
+++ b/bob/devtools/bootstrap.py
@@ -1,6 +1,8 @@
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
+'''Methods to bootstrap working environments based on conda-packages'''
+
import os
import json
import shutil
diff --git a/bob/devtools/changelog.py b/bob/devtools/changelog.py
index 3657ab5d..73aacbed 100644
--- a/bob/devtools/changelog.py
+++ b/bob/devtools/changelog.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
+'''Utilities for retrieving, parsing and auto-generating changelogs'''
import io
import datetime
diff --git a/bob/devtools/log.py b/bob/devtools/log.py
index 7b26d178..3cc7c783 100644
--- a/bob/devtools/log.py
+++ b/bob/devtools/log.py
@@ -1,7 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
-"""Sets-up logging, centrally for Bob.
+"""Logging utilities
"""
import sys
diff --git a/bob/devtools/release.py b/bob/devtools/release.py
index 8e0bbc79..5858bf55 100644
--- a/bob/devtools/release.py
+++ b/bob/devtools/release.py
@@ -1,6 +1,8 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
+'''Utilities to needed to release packages'''
+
import os
import re
import time
diff --git a/doc/api.rst b/doc/api.rst
index 8caad497..b3762d86 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -7,10 +7,13 @@
.. autosummary::
bob.devtools.log
+ bob.devtools.ci
bob.devtools.conda
+ bob.devtools.constants
bob.devtools.release
bob.devtools.changelog
bob.devtools.bootstrap
+ bob.devtools.webdav3.client
Detailed Information
@@ -18,10 +21,20 @@ Detailed Information
.. automodule:: bob.devtools.log
+.. automodule:: bob.devtools.ci
+
.. automodule:: bob.devtools.conda
+.. automodule:: bob.devtools.constants
+
.. automodule:: bob.devtools.release
.. automodule:: bob.devtools.changelog
.. automodule:: bob.devtools.bootstrap
+
+
+WebDAV Python Client
+--------------------
+
+.. automodule:: bob.devtools.webdav3.client
--
GitLab