Skip to content

feat(docs): Fix sections not rendering on Read the Docs #264

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

Merged
merged 17 commits into from
May 15, 2020

Conversation

yavorona
Copy link
Contributor

Summary

  • Added jsonschema dependency to fix rendering issues.
  • Included readme.md directly to index.rst instead of having readme.rst.

@yavorona yavorona requested a review from a team as a code owner May 15, 2020 20:36
@yavorona yavorona removed their assignment May 15, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.097% when pulling 27a3dcc on sphinx-docs-test into 140e420 on master.


readme

.. mdinclude:: ../../README.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, this was the change I needed.

m2r==0.2.1
jsonschema==3.2.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is jsonschema needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talked offline. jsonschema is needed to render docstrings from optimizely, config_manager , and optimizely_config.

m2r==0.2.1
jsonschema==3.2.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talked offline. jsonschema is needed to render docstrings from optimizely, config_manager , and optimizely_config.

@aliabbasrizvi
Copy link
Contributor

Looks like tests passed: https://travis-ci.org/github/optimizely/python-sdk/builds/687595137

Going to force merge this.

@aliabbasrizvi aliabbasrizvi merged commit 33a9191 into master May 15, 2020
@aliabbasrizvi aliabbasrizvi deleted the sphinx-docs-test branch May 15, 2020 22:47
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.

3 participants