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

Setting version for automatically updating documentation #118

Merged
merged 14 commits into from
Dec 17, 2019
Merged

Setting version for automatically updating documentation #118

merged 14 commits into from
Dec 17, 2019

Conversation

gwaybio
Copy link
Member

@gwaybio gwaybio commented Dec 13, 2019

No description provided.

@gwaybio
Copy link
Member Author

gwaybio commented Dec 13, 2019

currently --editable . in requirements.txt is enabling import cytominer-database in the tests, but prevents a sphinx import in setup.py.

@gwaybio gwaybio changed the title Adding Sphinx build to setup.py [WIP] Adding Sphinx build to setup.py Dec 13, 2019
@gwaybio
Copy link
Member Author

gwaybio commented Dec 16, 2019

Moving autobuild logic to setup.cfg file fixes the setup.py import bug (see 4a12531)

@gwaybio gwaybio changed the title [WIP] Adding Sphinx build to setup.py Setting version for automatically updating documentation Dec 16, 2019
@gwaybio gwaybio requested a review from shntnu December 16, 2019 16:30
shntnu
shntnu reviewed Dec 16, 2019
View reviewed changes
setup.py Outdated
@@ -1,9 +1,11 @@
import setuptools

name = "cytominer_database"
Copy link
Member

Choose a reason for hiding this comment

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

💯

shntnu
shntnu reviewed Dec 16, 2019
View reviewed changes
setup.py Outdated
"configparser>=3.5.0",
"csvkit>=1.0.2",
"pandas>=0.20.3",
"sphinx>=2.2.2",
Copy link
Member

Choose a reason for hiding this comment

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

@gwaygenomics we don't need sphinx and sphinx-rtd-theme for install, correct?

Copy link
Member

@shntnu shntnu Dec 16, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I was able to install, test, and also build the docs even without adding sphinx and sphinx-rtd-theme to setup.py

Copy link
Member Author

Choose a reason for hiding this comment

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

correct. This is leftover from a previous option to autobuild. I will remove!

shntnu
shntnu reviewed Dec 16, 2019
View reviewed changes
requirements.txt Outdated
@@ -5,3 +5,8 @@
pytest>=3.2.2
sphinx>=1.6.4
sphinx_rtd_theme>=0.2.5b1
backports.tempfile>=1.0rc1
Copy link
Member

Choose a reason for hiding this comment

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

I was able to install, test, and also build the docs even without these additions to requirements.txt

@gwaybio
remove sphinx from setup and remove non-document packages from requir…
a26b5a9 
…ements

also updating variable names to match .cfg file
@gwaybio
Copy link
Member Author

gwaybio commented Dec 16, 2019

a26b5a9 does the trick I think!

shntnu
shntnu reviewed Dec 16, 2019
View reviewed changes
setup.cfg Show resolved Hide resolved
@gwaybio gwaybio merged commit 38a97e3 into cytomining:master Dec 17, 2019
@gwaybio gwaybio deleted the auto-build-sphinx branch December 17, 2019 16:04
@gwaybio gwaybio mentioned this pull request Dec 17, 2019
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shntnu shntnu shntnu 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.
2 participants
@gwaybio @shntnu