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

Use Trio RTD theme, add readthedocs.yml #212

Merged
merged 1 commit into from May 7, 2020

Conversation

@sethmlarson
Copy link
Contributor

@sethmlarson sethmlarson commented May 6, 2020

RTD is failing because it installs the project via python setup.py install before installing dev-requirements.txt so doesn't have unasync. Added a readthedocs.yml file so we can control the install order and have RTD use pip install . instead of python setup.py install

I also pulled most of Trio's template, it looks good for now and the docs now just need content to be improved to look really nice. No logo yet so that section is empty and didn't immediately link to the Trio Discourse. The Stackoverflow tag doesn't exist yet but doesn't hurt to link to nothing?

@codecov
Copy link

@codecov codecov bot commented May 6, 2020

Codecov Report

Merging #212 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #212   +/-   ##
=======================================
  Coverage   99.70%   99.70%           
=======================================
  Files          28       28           
  Lines        2719     2719           
=======================================
  Hits         2711     2711           
  Misses          8        8           
Copy link
Member

@pquentin pquentin left a comment

Thanks, that looks nice!

@pquentin pquentin merged commit 0706f48 into python-trio:master May 7, 2020
16 checks passed
16 checks passed
package
Details
lint
Details
docs
Details
macOS (2.7)
Details
macOS (3.5)
Details
macOS (3.6)
Details
macOS (3.7)
Details
macOS (3.8)
Details
Windows (2.7)
Details
Windows (3.5)
Details
Windows (3.6)
Details
Windows (3.7)
Details
Windows (3.8)
Details
codecov/patch Coverage not affected when comparing 685e295...6937f5b
Details
codecov/project 99.70% (target 40.00%)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@sethmlarson
Copy link
Contributor Author

@sethmlarson sethmlarson commented May 7, 2020

🎉 Seems to have worked: https://hip.readthedocs.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.