Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Corrections to render sphinx correctly #819

Merged
merged 1 commit into from Nov 15, 2016
Merged

Conversation

TimDaub
Copy link
Contributor

@TimDaub TimDaub commented Nov 15, 2016

I took a look to see how they render via ReadTheDocs. It seems Sphinx got confused with how to render the Parameters and Status Codes.

Thx @ttmc, I should have checked the rendered output :/ (I did this time!)

@codecov-io
Copy link

codecov-io commented Nov 15, 2016

Current coverage is 96.85% (diff: 100%)

Merging #819 into master will not change coverage

@@             master       #819   diff @@
==========================================
  Files            26         26          
  Lines          1683       1683          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1630       1630          
  Misses           53         53          
  Partials          0          0          

Sunburst

Powered by Codecov. Last update 57d9374...5ef5329

@ttmc
Copy link
Contributor

ttmc commented Nov 15, 2016

This time I checked out the branch and rendered it locally just to see what happens. The Parameters and Status codes render fine now.

I also noticed it fails to syntax-highlight the final example response (HTTP). Sphinx gave the warning:

/home/troy/repos/bigchaindb/docs/server/source/drivers-clients/http-client-server-api.rst:316: WARNING: Could not lex literal_block as "http". Highlighting skipped.

I honestly don't see what's wrong or different from previous example HTTP response blocks. I'm not sure it matters that much though. I'd be okay with merging as is.

@TimDaub TimDaub merged commit 2fd6cc3 into master Nov 15, 2016
@vrde vrde deleted the docs/601/get_owned_ids branch March 21, 2018 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants