-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
ARROW-14496: [Docs] Create relative links for R / JS / C/Glib references in the sphinx toctree using stub pages #11601
Conversation
…ces in the sphinx toctree using stub pages
|
@jorisvandenbossche could you please fix the javadoc reference?
at https://github.com/apache/arrow/blob/master/docs/source/java/index.rst |
Ah, yes I forgot the Java reference link. Now, we actually don't have the reference included in any of the currently hosted older versions. So fixing this link as well would actually give broken links .. |
We need to regenerate the sphinx part for the previous versions and copy the language references back from previous site deployments, right? |
The java reference is a non-sphinx part, so that's not directly related to regenerating the sphinx site for older versions. |
How many versions including the javadoc would fit in the 1GB github pages limit? |
We can also erase the history of the asf-site branch and keep the last commit to reduce the overall repository size. |
Based on my comment in apache/arrow-site#139, adding the full content for versions 1 up to 5 would have added ~700MB. Which is already close to the limit, and within a half year / 2 more releases, we would hit the limit. |
How about just keeping e.g. the last 5 releases? |
@github-actions crossbow submit ubuntu-docs |
@github-actions crossbow submit test-ubuntu-docs |
@github-actions crossbow submit test-ubuntu-20.10-docs test-ubuntu-default-docs |
Revision: ad6e262 Submitted crossbow builds: ursacomputing/crossbow @ actions-1092
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Joris!
Benchmark runs are scheduled for baseline = 95e8b92 and contender = a9ba3f2. a9ba3f2 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
…ces in the sphinx toctree using stub pages This will create dummy pages like `/r/index.html` which can be used for sphinx to link to, but which should not be added to the actual hosted files for the arrow site (they have to be overwritten by the index.html files of the respective proper doc builds for R, js and C/Glib). Closes #11601 from jorisvandenbossche/ARROW-14496-toctree-external Authored-by: Joris Van den Bossche <[email protected]> Signed-off-by: Krisztián Szűcs <[email protected]>
This will create dummy pages like
/r/index.html
which can be used for sphinx to link to, but which should not be added to the actual hosted files for the arrow site (they have to be overwritten by the index.html files of the respective proper doc builds for R, js and C/Glib).