Skip to content

Split requirements/pip.txt #5100

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

Merged
merged 6 commits into from
Jan 15, 2019
Merged

Split requirements/pip.txt #5100

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2837933
Split requirements files
dojutsu-user Jan 13, 2019
29a1c2d
add modifications
dojutsu-user Jan 13, 2019
60c1c92
add pygments to lint.txt
dojutsu-user Jan 13, 2019
f75778e
make docs.txt
dojutsu-user Jan 14, 2019
c52fe13
move docs requirements back to local-docs-build
dojutsu-user Jan 15, 2019
e9e14e6
edit readthedocs.yml
dojutsu-user Jan 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions requirements/lint.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ pylint-celery==0.3
prospector==1.1.6.2
# prospector 1.1.6.2 is not compatible with 2.0.0
pyflakes<2.0.0
Pygments==2.3.1
Copy link
Member Author

Choose a reason for hiding this comment

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

I put this here because it was required to make the lint tests.
This gets repeated here as it was already moved to the local_docs_build.txt

23 changes: 23 additions & 0 deletions requirements/local-docs-build.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Base packages
docutils==0.14
Sphinx==1.8.3
sphinx_rtd_theme==0.4.2
sphinx-tabs==1.1.10
# Required to avoid Transifex error with reserved slug
# https://github.com/sphinx-doc/sphinx-intl/pull/27
git+https://github.com/agjohnson/sphinx-intl.git@7b5c66bdb30f872b3b1286e371f569c8dcb66de5#egg=sphinx-intl

Pygments==2.3.1

mkdocs==1.0.4
Markdown==3.0.1

# Docs
sphinxcontrib-httpdomain==1.7.0
sphinx-prompt==1.0.0
Copy link
Member

Choose a reason for hiding this comment

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

I suppose that these two packages are for building our own docs and not for building user's documentation. So, these should probably go into a different reqs file maybe.

Copy link
Member Author

Choose a reason for hiding this comment

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

Wasn't aware of that these are only for RTD docs.

these should probably go into a different reqs file maybe.

Since these are RTD-only requirements, we can put it back in the pip.txt

Copy link
Member

Choose a reason for hiding this comment

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

Well, they are not required to "run Read the Read software" but to build the docs of it.

So, basically, we should use this requirements/docs.txt file in our own projects under readthedocs.io (https://readthedocs.org/projects/docs/)

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay.
I have separated them in docs.txt and also add -r local-docs-build.txt to install the other dependencies.


# commonmark 0.5.5 is the latest version compatible with our docs, the
# newer ones make `tox -e docs` to fail
commonmark==0.5.5

recommonmark==0.4.0
7 changes: 0 additions & 7 deletions requirements/onebox.txt
View file
Open in desktop

This file was deleted.

22 changes: 0 additions & 22 deletions requirements/pip.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,6 @@
pip==18.1
appdirs==1.4.3
virtualenv==16.2.0
docutils==0.14
Sphinx==1.8.3
sphinx_rtd_theme==0.4.2
sphinx-tabs==1.1.10
# Required to avoid Transifex error with reserved slug
# https://github.com/sphinx-doc/sphinx-intl/pull/27
git+https://github.com/agjohnson/sphinx-intl.git@7b5c66bdb30f872b3b1286e371f569c8dcb66de5#egg=sphinx-intl

Pygments==2.3.1

mkdocs==1.0.4
Markdown==3.0.1

django==1.11.18
six==1.12.0
Expand Down Expand Up @@ -96,16 +84,6 @@ djangorestframework-jsonp==1.0.2
django-taggit==0.23.0
dj-pagination==2.4.0

# Docs
sphinxcontrib-httpdomain==1.7.0
sphinx-prompt==1.0.0

# commonmark 0.5.5 is the latest version compatible with our docs, the
# newer ones make `tox -e docs` to fail
commonmark==0.5.5

recommonmark==0.4.0

# Version comparison stuff
packaging==18.0

Expand Down
1 change: 1 addition & 0 deletions requirements/testing.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
-r pip.txt
-r local-docs-build.txt

django-dynamic-fixture==2.0.0
pytest==4.0.2
Expand Down