Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Documentation styling is broken #110

Closed
jdk514 opened this issue Nov 20, 2017 · 2 comments
Closed

Documentation styling is broken #110

jdk514 opened this issue Nov 20, 2017 · 2 comments

Comments

@jdk514
Copy link

jdk514 commented Nov 20, 2017

The styling of the pydocumentdb documentation appears to be broken.

@vchalmel
Copy link

vchalmel commented Nov 20, 2017

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
Copy link
Member

mimig1 commented Nov 20, 2017

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

@jdk514 jdk514 closed this as completed Nov 20, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants