Exclude certain class members from auto-generated documentation.

Review Request #7364 — Created June 2, 2015 and submitted

chipx86
Review Board
release-2.5.x
efc5662...
reviewboard
There were class members we didn't want to keep around, such as __dict__
and DoesNotExist. Since autodoc doesn't support simple exclusions like
this, I've written a new extension that makes use of the exclusion hook
to look up common member names and exclude them from the docs.

Built the docs and went through them. Saw that all these useless entries
that were auto-added have been removed.

reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/autodoc_utils.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
        docs/manual/_ext/autodoc_utils.py
    
    
  2. 
      
brennie
  1. Ship It!
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.5.x (8c31925)
Loading...