search

Azure / azure-cosmos-python

🚨🚨🚨This SDK is now maintained at https://github.com/Azure/azure-sdk-for-python 🚨🚨🚨
https://github.com/Azure/azure-sdk-for-python
MIT License
150 stars 141 forks source link

Documentation styling is broken #110

Closed jdk514 closed 6 years ago

jdk514 commented 6 years ago

The styling of the pydocumentdb documentation appears to be broken.

vchalmel commented 6 years ago

The online github version appears "blank" because it's not intended to be browsed like that. If you follow the instructions (given at the link you provided

To generate documentations:¶

    Install Sphinx: http://sphinx-doc.org/install.html

    $ cd doc
    $ sphinx-apidoc -f -e -o api ..\pydocumentdb
    $ make.bat html

), to compile the doc on your side, it will generate local files with correct styling/browsing, etc.

mimig1 commented 6 years ago

The styling of http://azure.github.io/azure-documentdb-python/ (with paragraph marks showing, etc) is as expected.