• 
      

    Skip documenting members listed in __deprecated__.

    Review Request #7470 — Created July 1, 2015 and submitted

    Information

    Djblets
    release-0.9.x
    0046655...

    Reviewers

    Sphinx will try to skip any members coming in through an import, but if
    they're listed in __all__, it's assumed they should be documented. We
    don't want this for any modules that are providing compatibility
    imports, as it's just confusing.

    Our excluder extension now looks for a __deprecated__ member of the
    module, and will exclude anything found in that list. This makes it easy
    for us to choose what in a module we want to exclude and what we don't.

    Used this to exclude some modules I'm deprecating.

    reviewbot
    1. Tool: Pyflakes
      Processed Files:
          docs/djblets/_ext/autodoc_utils.py
      
      
      
      Tool: PEP8 Style Checker
      Processed Files:
          docs/djblets/_ext/autodoc_utils.py
      
      
    2. 
        
    david
    1. Ship It!
    2. 
        
    chipx86
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-0.9.x (fa8eb5b)