diff options
author | Bernat Gabor <jokerjokerer@gmail.com> | 2017-12-06 23:50:52 +0000 |
---|---|---|
committer | Bernat Gabor <jokerjokerer@gmail.com> | 2017-12-07 00:15:47 +0000 |
commit | 04254e3c4718b9b2ee96fa38a5d67c8104989592 (patch) | |
tree | 0985a6ce0cb0eba50815a1fd3463579758a095bc /docs | |
parent | 660a88ef71a3619d39d23fd2bd0be44a9c82256c (diff) | |
download | dateutil-04254e3c4718b9b2ee96fa38a5d67c8104989592.tar.gz |
add document generation to tox, and trigger automatically at CI (also check links in documentation to avoid having dangling pointers to the internet)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 2 | ||||
-rw-r--r-- | docs/examples.rst | 6 | ||||
-rw-r--r-- | docs/relativedelta.rst | 10 | ||||
-rw-r--r-- | docs/zoneinfo.rst | 5 |
4 files changed, 13 insertions, 10 deletions
diff --git a/docs/conf.py b/docs/conf.py index 95695ab..79b71f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -135,7 +135,7 @@ html_theme = 'default' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/examples.rst b/docs/examples.rst index c049177..6e477fa 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -873,7 +873,7 @@ But when an `rruleset` is needed, it is automatically used. parse examples ------------ +-------------- The following code will prepare the environment: .. doctest:: tz @@ -1274,7 +1274,7 @@ in the year of 2003. Here is the example mentioned in the -[http://www.python.org/doc/current/lib/module-time.html time module documentation]. +[https://docs.python.org/3/library/time.html time module documentation]. .. testsetup:: tzstr @@ -1362,7 +1362,7 @@ DST is 1h in the given example) instead of the DST time. That's how the `tzinfo` subtypes should deal with the extra hour that happens when going back to the standard time. Check -[http://www.python.org/doc/current/lib/datetime-tzinfo.html tzinfo documentation] +[https://docs.python.org/3/library/datetime.html#datetime.tzinfo tzinfo documentation] for more information. diff --git a/docs/relativedelta.rst b/docs/relativedelta.rst index 72c882d..8769cc7 100644 --- a/docs/relativedelta.rst +++ b/docs/relativedelta.rst @@ -10,10 +10,10 @@ relativedelta Examples -------- - from datetime import *; from dateutil.relativedelta import * - import calendar - NOW = datetime(2003, 9, 17, 20, 54, 47, 282310) - TODAY = date(2003, 9, 17) + >>> from datetime import *; from dateutil.relativedelta import * + >>> import calendar + >>> NOW = datetime(2003, 9, 17, 20, 54, 47, 282310) + >>> TODAY = date(2003, 9, 17) Let's begin our trip:: @@ -208,4 +208,4 @@ We can use the non-leap year day to ignore this: .. doctest:: relativedelta >>> date(2000, 1, 1)+relativedelta(nlyearday=260) - datetime.date(2000, 9, 17)
\ No newline at end of file + datetime.date(2000, 9, 17) diff --git a/docs/zoneinfo.rst b/docs/zoneinfo.rst index 99591f9..d85f2c7 100644 --- a/docs/zoneinfo.rst +++ b/docs/zoneinfo.rst @@ -5,10 +5,13 @@ zoneinfo :members: :undoc-members: +.. automodule:: dateutil.zoneinfo.rebuild + :members: rebuild + zonefile_metadata ----------------- The zonefile metadata defines the version and exact location of -the timezone database to download. It is used in the :ref:`updatezinfo.py` +the timezone database to download. It is used in the ``updatezinfo.py`` script. A json encoded file is included in the source-code, and within each tar file we produce. The json file is attached here: |