Uploaded image for project: 'Python Driver'
  1. Python Driver
  2. PYTHON-2870

Support building the docs in non-html formats

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Unknown
    • Resolution: Fixed
    • None
    • 3.12.1, 4.0
    • None

    Description

       

      + /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
      running build_sphinx
      Running Sphinx v4.1.2
      making output directory... done
      loading intersphinx inventory from http://www.gevent.org/objects.inv...
      loading intersphinx inventory from https://docs.python.org/3/objects.inv...
      building [mo]: targets for 0 po files that are out of date
      building [man]: all manpages
      updating environment: [new config] 82 added, 0 changed, 0 removed
      reading sources... [100%] tutorial
      looking for now-outdated files... none found
      pickling environment... done
      checking consistency... done
      writing... python-pymongo..3 { atlas installation tutorial examples/index examples/aggregation examples/authentication examples/collations examples/copydb examples/custom_type examples/bulk examples/datetimes examples/geo examples/gevent examples/gridfs examples/high_availability examples/mod_wsgi examples/server_selection examples/tailable examples/tls examples/encryption examples/uuid faq compatibility-policy api/index api/bson/index api/bson/binary api/bson/code api/bson/codec_options api/bson/dbref api/bson/decimal128 api/bson/errors api/bson/int64 api/bson/json_util api/bson/max_key api/bson/min_key api/bson/objectid api/bson/raw_bson api/bson/regex api/bson/son api/bson/timestamp api/bson/tz_util api/pymongo/index api/pymongo/bulk api/pymongo/change_stream api/pymongo/client_session api/pymongo/collation api/pymongo/collection api/pymongo/command_cursor api/pymongo/cursor api/pymongo/cursor_manager api/pymongo/database api/pymongo/driver_info api/pymongo/encryption api/pymongo/encryption_options api/pymongo/errors api/pymongo/message api/pymongo/mongo_client api/pymongo/mongo_replica_set_client api/pymongo/monitoring api/pymongo/operations api/pymongo/pool api/pymongo/read_concern api/pymongo/read_preferences api/pymongo/results api/pymongo/son_manipulator api/pymongo/uri_parser api/pymongo/write_concern api/pymongo/event_loggers api/gridfs/index api/gridfs/errors api/gridfs/grid_file tools contributors changelog python3 migrate-to-pymongo3 developer/index developer/periodic_executor } /home/tkloczko/rpmbuild/BUILD/mongo-python-driver-3.11.4/doc/mongo_extensions.py:78: FutureWarning:
         The iterable returned by Node.traverse()
         will become an iterator instead of a list in Docutils > 0.16.
        tag = str(para.traverse()[1])
      failedException occurred:
        File "/usr/lib/python3.8/site-packages/sphinx/writers/manpage.py", line 466, in unknown_visit
          raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
      NotImplementedError: Unknown node: mongodoc
      The full traceback has been saved in /tmp/sphinx-err-xefpu3lh.log, if you want to report the issue to the developers.
      Please also report this if it was a user error, so that a better error message can be provided next time.
      A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
       
      [tkloczko@barrel SPECS]$ cat /tmp/sphinx-err-xefpu3lh.log
      # Sphinx version: 4.1.2
      # Python version: 3.8.11 (CPython)
      # Docutils version: 0.17.1 release
      # Jinja2 version: 3.0.1
      # Last messages:
      #   api/gridfs/grid_file
      #   tools
      #   contributors
      #   changelog
      #   python3
      #   migrate-to-pymongo3
      #   developer/index
      #   developer/periodic_executor
      #   }
      #   failed
      # Loaded extensions:
      #   sphinx.ext.mathjax (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/mathjax.py
      #   sphinxcontrib.applehelp (1.0.2) from /usr/lib/python3.8/site-packages/sphinxcontrib/applehelp/__init__.py
      #   sphinxcontrib.devhelp (1.0.2) from /usr/lib/python3.8/site-packages/sphinxcontrib/devhelp/__init__.py
      #   sphinxcontrib.htmlhelp (2.0.0) from /usr/lib/python3.8/site-packages/sphinxcontrib/htmlhelp/__init__.py
      #   sphinxcontrib.serializinghtml (1.1.5) from /usr/lib/python3.8/site-packages/sphinxcontrib/serializinghtml/__init__.py
      #   sphinxcontrib.qthelp (1.0.2) from /usr/lib/python3.8/site-packages/sphinxcontrib/qthelp/__init__.py
      #   alabaster (0.7.12) from /usr/lib/python3.8/site-packages/alabaster/__init__.py
      #   sphinx.ext.autodoc.preserve_defaults (1.0) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/preserve_defaults.py
      #   sphinx.ext.autodoc.type_comment (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/type_comment.py
      #   sphinx.ext.autodoc (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py
      #   sphinx.ext.doctest (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/doctest.py
      #   sphinx.ext.coverage (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/coverage.py
      #   sphinx.ext.todo (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/todo.py
      #   doc.mongo_extensions (unknown version) from /home/tkloczko/rpmbuild/BUILD/mongo-python-driver-3.11.4/doc/mongo_extensions.py
      #   sphinx.ext.intersphinx (4.1.2) from /usr/lib/python3.8/site-packages/sphinx/ext/intersphinx.py
      Traceback (most recent call last):
        File "/usr/lib/python3.8/site-packages/sphinx/setup_command.py", line 177, in run
          app.build(force_all=self.all_files)
        File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 343, in build
          self.builder.build_update()
        File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 290, in build_update
          self.build(['__all__'], to_build)
        File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 357, in build
          self.write(docnames, list(updated_docnames), method)
        File "/usr/lib/python3.8/site-packages/sphinx/util/__init__.py", line 547, in wrapper
          return f(*args, **kwargs)
        File "/usr/lib/python3.8/site-packages/sphinx/builders/manpage.py", line 104, in write
          docwriter.write(largetree, destination)
        File "/usr/lib/python3.8/site-packages/docutils/writers/__init__.py", line 78, in write
          self.translate()
        File "/usr/lib/python3.8/site-packages/sphinx/writers/manpage.py", line 39, in translate
          self.document.walkabout(visitor)
        File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 227, in walkabout
          if child.walkabout(visitor):
        File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 227, in walkabout
          if child.walkabout(visitor):
        File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 227, in walkabout
          if child.walkabout(visitor):
        [Previous line repeated 6 more times]
        File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 219, in walkabout
          visitor.dispatch_visit(self)
        File "/usr/lib/python3.8/site-packages/sphinx/util/docutils.py", line 472, in dispatch_visit
          super().dispatch_visit(node)
        File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2021, in dispatch_visit
          return method(node)
        File "/usr/lib/python3.8/site-packages/sphinx/writers/manpage.py", line 466, in unknown_visit
          raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
      NotImplementedError: Unknown node: mongodoc
      

       

      Attachments

        Issue Links

          Activity

            People

              shane.harvey@mongodb.com Shane Harvey
              kloczko.tomasz@gmail.com Tomasz Kłoczko
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: