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

requirements: Move nose and sphinx to dev requirements. See #230 #231

Merged
merged 3 commits into from
Apr 24, 2017

Conversation

jcfr
Copy link
Collaborator

@jcfr jcfr commented Mar 29, 2017

No description provided.

flake8
flake8-import-order
sphinx>=1.4
sphinx_rtd_theme>=0.2.2
Copy link
Collaborator

Choose a reason for hiding this comment

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

would this require user to install the dev version of pyradiomics before documentation can be built? (or have users install sphinx and sphinx-rtd-theme manually?)

@jcfr
Copy link
Collaborator Author

jcfr commented Mar 29, 2017

install the dev version of pyradiomics

What do you mean by dev version ?

To summarize, as it was before building the doc can be achieved doing:

git clone https://github.com/Radiomics/pyradiomic
cd pyradiomic
pip install -r requirements.txt  -r requirements-dev.txt
cd docs; make html

The advantage of this commit is that it avoids installing sphinx related packages while simply doing pip install pyradiomics.

I would also suggest to remove this line: https://github.com/Radiomics/pyradiomics/blob/d00212cd407d96604d5d9f1581661547efd3be3a/MANIFEST.in#L15

@JoostJM
Copy link
Collaborator

JoostJM commented Mar 30, 2017

What do you mean by dev version ?

python setup.py develop? Or when are the development requirements installed by the setup script?

To summarize, as it was before building the doc can be achieved doing:

Building the docs does require pyradiomics to be installed, as it uses the __version__ of pyradiomics to specify the package version when building the docs.

This is not needed for the online documentation on readthedocs, but it is reflected in the downloadable pdf or custom build documentation (this was set at 0.0.1). I changed this in #216 to use the actual version of pyradiomics.

I would also suggest to remove this line: https://github.com/Radiomics/pyradiomics/blob/d00212cd407d96604d5d9f1581661547efd3be3a/MANIFEST.in#L15

I agree

@JoostJM
Copy link
Collaborator

JoostJM commented Apr 5, 2017

@jcfr, can you update the manifest and merge?

@JoostJM
Copy link
Collaborator

JoostJM commented Apr 21, 2017

@jcfr, what is the status on this PR?

@JoostJM JoostJM force-pushed the reorganize-requirements branch from 99bbb0b to 6d77fd0 Compare April 24, 2017 08:33
@JoostJM
Copy link
Collaborator

JoostJM commented Apr 24, 2017

Rebased onto master to resolve conflict (due to the removal of the tqdm dependency in #232)

@JoostJM JoostJM force-pushed the reorganize-requirements branch from 6d77fd0 to 17000a6 Compare April 24, 2017 08:35
@JoostJM JoostJM merged commit 90efc86 into master Apr 24, 2017
@JoostJM JoostJM mentioned this pull request Apr 25, 2017
3 tasks
JoostJM added a commit that referenced this pull request May 24, 2017
Update documentation to reflect changes made in #231
@jcfr jcfr deleted the reorganize-requirements branch October 11, 2017 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants