Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
bob.db.ldhf
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository 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
bob
bob.db.ldhf
Commits
db889c8b
Commit
db889c8b
authored
4 years ago
by
Amir MOHAMMADI
Browse files
Options
Downloads
Patches
Plain Diff
Sphinx 3 autodoc no longer accepts autodoc_default_flags and autodoc_default_options should be used
parent
50fc84a7
Branches
master
No related tags found
No related merge requests found
Pipeline
#45503
passed with stages
in 7 minutes and 16 seconds
Changes
1
Pipelines
2
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/conf.py
+6
-25
6 additions, 25 deletions
doc/conf.py
with
6 additions
and
25 deletions
doc/conf.py
+
6
−
25
View file @
db889c8b
...
...
@@ -229,12 +229,12 @@ rst_epilog = """
# Default processing flags for sphinx
autoclass_content
=
'
class
'
autodoc_member_order
=
'
bysource
'
autodoc_default_
flag
s
=
[
'
members
'
,
'
undoc-members
'
,
'
inherited-members
'
,
'
show-inheritance
'
,
]
autodoc_default_
option
s
=
{
"
members
"
:
True
,
"
undoc-members
"
:
True
,
"
inherited-members
"
:
True
,
"
show-inheritance
"
:
True
,
}
# For inter-documentation mapping:
from
bob.extension.utils
import
link_documentation
,
load_requirements
...
...
@@ -248,24 +248,5 @@ else:
intersphinx_mapping
=
link_documentation
()
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions
=
[
'
__array__
'
]
def
member_function_test
(
app
,
what
,
name
,
obj
,
skip
,
options
):
# test if we have a private function
if
len
(
name
)
>
1
and
name
[
0
]
==
'
_
'
:
# test if this private function should be allowed
if
name
not
in
accepted_private_functions
:
# omit privat functions that are not in the list of accepted private functions
return
skip
else
:
# test if the method is documented
if
not
hasattr
(
obj
,
'
__doc__
'
)
or
not
obj
.
__doc__
:
return
skip
return
False
def
setup
(
app
):
app
.
connect
(
'
autodoc-skip-member
'
,
member_function_test
)
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