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.

Sign up for GitHub

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

Jump to bottom

feat(docs): Creating Read the Docs config file for Sphinx Docs #263

Merged
merged 4 commits into from
May 14, 2020
Merged

feat(docs): Creating Read the Docs config file for Sphinx Docs #263

merged 4 commits into from
May 14, 2020

Conversation

yavorona
Copy link
Contributor

Summary

Creating Read the Docs config file for sphinx docs

@yavorona yavorona requested a review from a team as a code owner May 14, 2020 19:07
aliabbasrizvi
aliabbasrizvi reviewed May 14, 2020
View reviewed changes
.readthedocs.yml Outdated
sphinx:
configuration: docs/conf.py

# Optionally set the version of Python and requirements required to build your docs
Copy link
Contributor

Choose a reason for hiding this comment

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

You can remove this

@coveralls
Copy link

coveralls commented May 14, 2020 •
edited
Loading

Coverage Status

Coverage remained the same at 97.097% when pulling 759d972 on pnguen/readthedocs-config into 9d18756 on master.

aliabbasrizvi
aliabbasrizvi approved these changes May 14, 2020
View reviewed changes
Copy link
Contributor

@aliabbasrizvi aliabbasrizvi left a comment

Choose a reason for hiding this comment

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

LGTM

aliabbasrizvi
aliabbasrizvi reviewed May 14, 2020
View reviewed changes
.readthedocs.yml Outdated

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
Copy link
Contributor

Choose a reason for hiding this comment

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

This will probably need to be docs/source/conf.py

@yavorona yavorona merged commit 140e420 into master May 14, 2020
@yavorona yavorona deleted the pnguen/readthedocs-config branch May 14, 2020 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aliabbasrizvi aliabbasrizvi aliabbasrizvi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@yavorona @coveralls @aliabbasrizvi