You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "AlenkaF (via GitHub)" <gi...@apache.org> on 2023/05/16 09:02:58 UTC
[GitHub] [arrow] AlenkaF opened a new pull request, #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
AlenkaF opened a new pull request, #35610:
URL: https://github.com/apache/arrow/pull/35610
### Rationale for this change
Ease the process of building the documentation for dev purposes.
### What changes are included in this PR?
- `make` options to build subsections of the documentation (format, developers, cpp together with existing python)
- `make` option for auto-build of the docs
- new landing pages for format, developers and cpp sections of the docs
- `toctree` restructuring for the developers section
- added info about the new make commands
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1569816246
Yeah, unfortunately this is a consequence of building from the subdirectory.
The source dir is in this case `docs/source/developers/` but the link of the picture points to the subdir named `developers/` which only exists if the source dir is `docs/source`
```
R package Architectural Overview
--------------------------------
.. figure:: /developers/images/R_architectural_overview.png
:alt: Main parts of R package architecture: dplyr-*,
dplyr-funcs*, tools, tests and src/.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1550852246
Revision: 4241d2c8833e7debab43d9997fc011d39af8e196
Submitted crossbow builds: [ursacomputing/crossbow @ actions-5e14c843d2](https://github.com/ursacomputing/crossbow/branches/all?query=actions-5e14c843d2)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/5000278889/jobs/8957498813)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1569980899
Oh, this is great. Sorry I haven't noticed it before, thanks!
Will correct 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1569807161
When trying `make dev` (on a clean build), I get warnings about the images not being found:
```
/home/joris/scipy/repos/arrow/docs/source/developers/guide/architectural_overview.rst:: WARNING: image file not readable: developers/images/R_architectural_overview.png
/home/joris/scipy/repos/arrow/docs/source/developers/guide/documentation.rst:: WARNING: image file not readable: developers/images/edit_page.jpeg
/home/joris/scipy/repos/arrow/docs/source/developers/guide/documentation.rst:: WARNING: image file not readable: developers/images/github_edit_page.jpeg
...
```
Is that a consequence of building only the subdirectory?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1567422306
Revision: 57e7d98c4dab495693a19d70f6fbc5097e936d8c
Submitted crossbow builds: [ursacomputing/crossbow @ actions-e577312887](https://github.com/ursacomputing/crossbow/branches/all?query=actions-e577312887)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/5114552742/jobs/9194908426)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1569818743
When just building the format docs (`make format`), I see that some images _do_ work, though. Those use a relative path, so that could maybe be a solution
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche merged pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche merged PR #35610:
URL: https://github.com/apache/arrow/pull/35610
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "ursabot (via GitHub)" <gi...@apache.org>.
ursabot commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1573506462
['Python', 'R'] benchmarks have high level of regressions.
[ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/c76345a2ae464f8fa4bbf5dc2974993e...7f66fc2b62e346c39237dd59ec2e2a03/)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1550910280
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1550849301
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1569819567
So eg `.. figure:: ../images/R_architectural_overview.png` instead of `.. figure:: /developers/images/R_architectural_overview.png`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1571928691
Revision: 6acb6165f6fab187dd1becdb3169dd0de0f2ff2d
Submitted crossbow builds: [ursacomputing/crossbow @ actions-62a9871213](https://github.com/ursacomputing/crossbow/branches/all?query=actions-62a9871213)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/5144075191/jobs/9259898039)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1571924663
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1567420687
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "ursabot (via GitHub)" <gi...@apache.org>.
ursabot commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1573497742
Benchmark runs are scheduled for baseline = 0bb2d83a3bba92a28495a67de74d94598e456625 and contender = c67fb399078b1cc1b4a10d88811f1c758ca91f82. c67fb399078b1cc1b4a10d88811f1c758ca91f82 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/7a38b40f7ce44f3d98a6633304f5b29c...341ad88d1839448b90c7f5c308dfa3a7/)
[Failed :arrow_down:0.62% :arrow_up:0.09%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/ef5eecf3167a431492b336889e9350ba...0a46ac1c92214e49888a9870d04d8e3f/)
[Finished :arrow_down:2.61% :arrow_up:0.33%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/c76345a2ae464f8fa4bbf5dc2974993e...7f66fc2b62e346c39237dd59ec2e2a03/)
[Finished :arrow_down:1.02% :arrow_up:0.03%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/6791710bfbfc48b2a04d874bec6328c5...0687a523c76e40328b1a62d8d277f87b/)
Buildkite builds:
[Finished] [`c67fb399` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2966)
[Failed] [`c67fb399` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/3002)
[Finished] [`c67fb399` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2967)
[Finished] [`c67fb399` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2992)
[Finished] [`0bb2d83a` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2965)
[Finished] [`0bb2d83a` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/3001)
[Finished] [`0bb2d83a` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2966)
[Finished] [`0bb2d83a` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2991)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1550916175
Revision: 1e557a76c378ab2436edf5b05c057ca2e1b2e47b
Submitted crossbow builds: [ursacomputing/crossbow @ actions-44b93dabd0](https://github.com/ursacomputing/crossbow/branches/all?query=actions-44b93dabd0)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/5000673621/jobs/8958374643)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #35610: GH-35609: [Docs] Enable the build of subsections of the documentation
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35610:
URL: https://github.com/apache/arrow/pull/35610#issuecomment-1549278065
* Closes: #35609
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org