Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
bob.devtools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
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.devtools
Commits
7d71a053
Commit
7d71a053
authored
5 years ago
by
André Anjos
Browse files
Options
Downloads
Patches
Plain Diff
[doc] Remove private member sphinx patch
parent
60d7768c
No related branches found
No related tags found
No related merge requests found
Pipeline
#38782
passed
5 years ago
Stage: build
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/conf.py
+0
-20
0 additions, 20 deletions
doc/conf.py
with
0 additions
and
20 deletions
doc/conf.py
+
0
−
20
View file @
7d71a053
...
@@ -231,23 +231,3 @@ autodoc_default_flags = [
...
@@ -231,23 +231,3 @@ autodoc_default_flags = [
# Adds simplejson, pyzmq links
# Adds simplejson, pyzmq links
#intersphinx_mapping['http://simplejson.readthedocs.io/en/stable/'] = None
#intersphinx_mapping['http://simplejson.readthedocs.io/en/stable/'] = None
#intersphinx_mapping['http://pyzmq.readthedocs.io/en/stable/'] = None
#intersphinx_mapping['http://pyzmq.readthedocs.io/en/stable/'] = None
# 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