[tor-bugs] #7507 [Stem]: Sphinx warnings about "missing attribute mentioned"

[Tor Bug Tracker & Wiki]

#7507: Sphinx warnings about "missing attribute mentioned"
---------------------+------------------------------------------------------
 Reporter:  atagar   |          Owner:  atagar
     Type:  defect   |         Status:  new   
 Priority:  minor    |      Milestone:        
Component:  Stem     |        Version:        
 Keywords:  website  |         Parent:        
   Points:           |   Actualpoints:        
---------------------+------------------------------------------------------

Comment(by eoinof):

 There are 2 main issues.

  1) WARNING: Duplicate explicit target name: "ticket".
     This can be fixed by using a diferent target name for each different
 link
     e.g. instead of:
            (`ticket <https://trac.torproject.org/1101>`_)
          use:
            (`ticket 1101 <https://trac.torproject.org/1101>`_)
     If anyone has a preference for the best name to use I'll put together
 a
     github commit.

  2) WARNING: missing attribute.
     These are caused by the __all__ list in the different __init__.py
 files
     Sphinx uses the __all__ list to check every module is loaded, but in
 some cases
     it is not and the warning is generated.
     One way to fix this would be to get rid of the __all__ list in each
 __init__.py
     file, though that would prevent someone from writing code like:
     {{{
     from stem import *
     }}}
     For example the stem.process module is not loaded by any other module
 so when
     sphinx runs it cannot match the module as described in __all__

 These are the current warnings from sphinx.
 {{{
 sphinx-build -b html -d _build/doctrees   . _build/html
 Making output directory...
 Running Sphinx v1.1.3
 loading pickled environment... not yet created
 building [html]: targets for 34 source files that are out of date
 updating environment: 34 added, 0 changed, 0 removed
 reading sources... [100%] tutorials/tortoise_and_the_hare
 /home/eoin/stemClean/stem/docs/api/connection.rst:2: WARNING: Duplicate
 explicit target name: "ticket".
 /home/eoin/stemClean/stem/docs/api/control.rst:9: WARNING: missing
 attribute mentioned in :members: or __all__: module stem, attribute
 process
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute export
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute reader
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute extrainfo_descriptor
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute server_descriptor
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute microdescriptor
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute networkstatus
 /home/eoin/stemClean/stem/docs/api/descriptor/descriptor.rst:4: WARNING:
 missing attribute mentioned in :members: or __all__: module
 stem.descriptor.__init__, attribute router_status_entry
 /home/eoin/stemClean/stem/docs/api/response.rst:4: WARNING: missing
 attribute mentioned in :members: or __all__: module stem.response,
 attribute getinfo
 /home/eoin/stemClean/stem/docs/api/response.rst:4: WARNING: missing
 attribute mentioned in :members: or __all__: module stem.response,
 attribute getconf
 /home/eoin/stemClean/stem/docs/api/response.rst:4: WARNING: missing
 attribute mentioned in :members: or __all__: module stem.response,
 attribute protocolinfo
 /home/eoin/stemClean/stem/docs/api/response.rst:4: WARNING: missing
 attribute mentioned in :members: or __all__: module stem.response,
 attribute authchallenge
 looking for now-outdated files... none found
 pickling environment... done
 checking consistency... done
 preparing documents... done
 writing output... [100%] tutorials/tortoise_and_the_hare
 writing additional files... (31 module code pages) _modules/index
  genindex py-modindex search
 copying images... [100%] _static/buttons/tutorials.png
 copying static files... done
 dumping search index... done
 dumping object inventory... done
 build succeeded, 13 warnings.

 Build finished. The HTML pages are in _build/html.
 }}}

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/7507#comment:1>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online