Sphinx Doc output directory is wrong?

[slominskir]

It looks like the Developer notes indicate the wrong output directory. When I run Sphinx the last message printed to the console is:

The HTML pages are in build\sphinx\html.

However, the docs in there are missing details and only contain section headers. That might be a separate issue related to the errors I see when Sphinx is run:

(.venv) C:\Users\ryans\IdeaProjects\confluent-kafka-python>python setup.py build_sphinx
running build_sphinx
Running Sphinx v3.5.4
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] index
←[91mWARNING: autodoc: failed to import module 'admin' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'Consumer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'DeserializingConsumer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'Producer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'SerializingProducer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.SchemaRegistryClient' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'avro.AvroProducer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'avro.AvroConsumer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.Deserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.avro.AvroDeserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.DoubleDeserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.IntegerDeserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.json_schema.JSONDeserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.protobuf.ProtobufDeserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.StringDeserializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.Serializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.avro.AvroSerializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.DoubleSerializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.IntegerSerializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.json_schema.JSONSerializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.protobuf.ProtobufSerializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.StringSerializer' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'Message' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'TopicPartition' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.MessageField' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'serialization.SerializationContext' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.Schema' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.RegisteredSchema' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'schema_registry.error.SchemaRegistryError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'KafkaError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'KafkaException' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.ConsumeError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.ProduceError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.SerializationError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.KeySerializationError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.ValueSerializationError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.KeyDeserializationError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'error.ValueDeserializationError' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
←[91mWARNING: autodoc: failed to import class 'ThrottleEvent' from module 'confluent_kafka'; the following exception was raised:
DLL load failed while importing cimpl: The specified module could not be found.←[39;49;00m
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 39 warnings.

The HTML pages are in build\sphinx\html.

[edenhill]

For make docs (which is the preferred method) the docs will be generated in docs/_build.

[mhowlett]

thanks for the PR! closing following @edenhill 's comment