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

[MRG+1] Add sphinx_rtd_theme to docs setup readme #2668

Merged
merged 3 commits into from Apr 24, 2017

Conversation

@harshasrinivas
Copy link
Contributor

@harshasrinivas harshasrinivas commented Mar 20, 2017

Concerns Sphinx 1.4 release #1893 . sphinx_rtd_theme has to be installed manually.

@redapple
Copy link
Contributor

@redapple redapple commented Mar 20, 2017

What about adding a requirements.txt to scrapy/docs/ and referencing if in tox.ini's [docs]?

@harshasrinivas
Copy link
Contributor Author

@harshasrinivas harshasrinivas commented Mar 20, 2017

@redapple Yes, I too thought of the same. :)
But since there are just 2 requirements for building the docs, do you think adding a requirements.txt would be beneficial?

@redapple
Copy link
Contributor

@redapple redapple commented Mar 20, 2017

I think it would still be easier to pip install -r docs/requirements.txt

@harshasrinivas
Copy link
Contributor Author

@harshasrinivas harshasrinivas commented Mar 20, 2017

Sure @redapple , adding right away.

@codecov-io
Copy link

@codecov-io codecov-io commented Mar 20, 2017

Codecov Report

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

@@           Coverage Diff           @@
##           master    #2668   +/-   ##
=======================================
  Coverage   84.66%   84.66%           
=======================================
  Files         162      162           
  Lines        9122     9122           
  Branches     1353     1353           
=======================================
  Hits         7723     7723           
  Misses       1141     1141           
  Partials      258      258

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec55799...83aa0c5. Read the comment docs.

@@ -15,7 +15,7 @@ and all its dependencies run

::

pip install 'Sphinx >= 1.3' sphinx_rtd_theme
pip install -r requirements.txt

This comment has been minimized.

@redapple

redapple Mar 20, 2017
Contributor

I'm not sure that it's clear that you would run this inside scrapy/docs/

This comment has been minimized.

@harshasrinivas

harshasrinivas Mar 20, 2017
Author Contributor

Just like the Compile the documentation part of this README, to maintain uniformity shall I mention "run the following command from this dir"?

This comment has been minimized.

@redapple

redapple Mar 21, 2017
Contributor

That would not hurt indeed.

Copy link
Contributor

@redapple redapple left a comment

Looks good to me.

@redapple redapple changed the title Add sphinx_rtd_theme to docs setup readme [MRG+1] Add sphinx_rtd_theme to docs setup readme Mar 22, 2017
@redapple redapple merged commit aa59cf4 into scrapy:master Apr 24, 2017
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
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

3 participants