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

Githhub-pages site should include both Python and R package docs #131

Open
jameslamb opened this issue Oct 25, 2018 · 1 comment
Open

Githhub-pages site should include both Python and R package docs #131

jameslamb opened this issue Oct 25, 2018 · 1 comment

Comments

@jameslamb
Copy link
Collaborator

Right now, we are building our Github Pages site off the docs/ folder on master. That only includes the pkgdown site for the R package.

Thanks to @csyhuang on #130 , the Python package will soon have Sphinx docs.

We should have a strategy for hosting Python and R docs together on https://uptakeopensource.github.io/uptasticsearch/

One strategy could be to write a custom index.html with links down to python-specific and R-specific folders and then to add something like this to Makefile:

site: docs_r docs_python
    mv r-pkg/docs docs/r/
    mv py-pkg/docs/built docs/py

But totally open to other suggestions! Also note that our current strategy for pkgdown has been to host all the files checked into the repo on master, but surely there must be a better way.

@jayqi
Copy link

jayqi commented Oct 8, 2019

Yes please. Also the URL to the docs site is not in the repo description as is convention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants