1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
Description: Exclude common.py:lazy_property from documentation
Needed as Sphinx 2 can't process it
This is obviously not an ideal fix, but it's an internal class with little
documentation to begin with:
https://snakemake.readthedocs.io/en/stable/api_reference/internal/snakemake.html#snakemake.common.lazy_property
Also exclude Flask.request due to
https://github.com/sphinx-doc/sphinx/issues/7516
Author: Rebecca N. Palmer <rebecca_palmer@zoho.com>
Bug-Debian: https://bugs.debian.org/955056
Forwarded: https://github.com/snakemake/snakemake/issues/296#issuecomment-611197453
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -116,6 +116,8 @@ pygments_style = "sphinx"
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
+# skip internal class that Sphinx 2 can't process (#296)
+autodoc_default_options = {'exclude-members': 'lazy_property, request'}
# -- Options for HTML output ----------------------------------------------
|
