Skip to content

Commit

Permalink
probably need to maintain new reqs in docs until new peppy is on pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
@vreuter
vreuter committed May 2, 2019
1 parent 8d38a2d commit 8eddb27
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions requirements/requirements-doc.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ mkdocs>=1.0
markdown-include
pydoc-markdown
https://github.com/databio/mkdocs-databio/archive/master.zip
ngstk
ubiquerg
peppy

6 comments on commit 8eddb27

@nsheff
Copy link
Contributor

@nsheff nsheff commented on 8eddb27 May 2, 2019

Choose a reason for hiding this comment

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

yeah I just figured it would resolve automatically as soon as the release happened.

@vreuter
Copy link
Member Author

@vreuter vreuter commented on 8eddb27 May 3, 2019

Choose a reason for hiding this comment

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

Yeah, it's seems odd to me, though; unless we're doing something atypical, it seems if we correctly understand what was causing the build failure (namely, installation from PyPI of the package to document + introduction of new dependencies in the dev version), that any analogous situation would suffer the same problem--i.e., any time a package introduces new dependencies, the docs builds will fail until it's released (so the notion of "dev" documentation would never be available for any dev version that includes new dependencies). That feels like a strange setup from RTD, but maybe I'm misunderstanding what's going on, or there's some current configuration workaround for this thing, or one in the RTD development pipeline as a future enhancement.

@nsheff
Copy link
Contributor

@nsheff nsheff commented on 8eddb27 May 8, 2019

Choose a reason for hiding this comment

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

I think what's atypical about it (for mkdocs at least) is that our documentation depends on the package itself. because of lucidoc. so we install the package itself, but that leads to some issues with versions because we can't specify to use the dev version on the dev docs...

@vreuter
Copy link
Member Author

@vreuter vreuter commented on 8eddb27 May 8, 2019

Choose a reason for hiding this comment

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

Yeah, it seems like there should be a hook to tell RTD to pull a branch from web-hosted repository and install from there rather than PyPI (and maybe there is, but I haven't looked into it).

@nsheff
Copy link
Contributor

@nsheff nsheff commented on 8eddb27 May 8, 2019

Choose a reason for hiding this comment

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

yeah, you can do that -- the issue is that you can't differentiate between the master and dev branches...

@nsheff
Copy link
Contributor

@nsheff nsheff commented on 8eddb27 May 8, 2019

Choose a reason for hiding this comment

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

so in other words, you could have both master and dev docs point to the dev branch on github, or to pypi...but what you want is for the master docs to point to pypi, and the dev docs to point to the dev branch on github. no can do...

Please sign in to comment.