Uploaded image for project: 'Motor'
  1. Motor
  2. MOTOR-10

Warning message on documentation generation

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Trivial - P5 Trivial - P5
    • 0.2
    • Affects Version/s: None
    • Component/s: Docs
    • None

      When generating the documentation, a warning message is displayed:

      sphinx-build -b html -d _build/doctrees   . _build/html
      Making output directory...
      Running Sphinx v1.1.3
      loading pickled environment... not yet created
      loading intersphinx inventory from http://api.mongodb.org/python/current/objects.inv...
      building [html]: targets for 21 source files that are out of date
      updating environment: 21 added, 0 changed, 0 removed
      reading sources... [100%] tutorial                                                                                                                                                  
      looking for now-outdated files... none found
      pickling environment... done
      checking consistency... done
      preparing documents... done
      writing output... [100%] tutorial                                                                                                                                                   
      <autodoc>:None: WARNING: unknown document: /examples/aggregation
      writing additional files... genindex search
      copying images... [100%] _static/motor.png                                                                                                                                          
      copying static files... done
      dumping search index... done
      dumping object inventory... done
      build succeeded, 1 warning.
      
      Build finished. The HTML pages are in _build/html.
      

      Generating a bad-formed cross reference in the map_reduce method of the Collection class:
      https://motor.readthedocs.org/en/latest/api/motor_collection.html#motor.MotorCollection.map_reduce

      What would be the best solution for this?

      • Delete the following line of the docstring from PyMongo?
      • Delete the seealso node when exists a document reference on inherited documentation?

      In either case, can I go for it?

            Assignee:
            jesse@mongodb.com A. Jesse Jiryu Davis
            Reporter:
            puentesarrin Jorge Puente SarrĂ­n
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: