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

[Docs] Enable the build of subsections of the documentation #35609

Closed
AlenkaF opened this issue May 16, 2023 · 0 comments · Fixed by #35610
Closed

[Docs] Enable the build of subsections of the documentation #35609

AlenkaF opened this issue May 16, 2023 · 0 comments · Fixed by #35610
Assignees
@AlenkaF
Labels
Component: Documentation Type: enhancement
Milestone
13.0.0

Comments

@AlenkaF
Copy link
Member

AlenkaF commented May 16, 2023

Describe the enhancement requested

We should add new make commands to be able to build only a subset of the docs like we can currently do with make python.

Connected to the work in #30627, this issue would be easy first solution without needing to make separate sphinx projects and use Intersphinx.

The links will in this case break but the documentation can still be built and the development can be hugely simplified with it.

Component(s)

Documentation
@AlenkaF AlenkaF self-assigned this May 16, 2023
@github-actions github-actions bot mentioned this issue May 16, 2023
Merged
@AlenkaF AlenkaF mentioned this issue May 16, 2023
Closed
@AlenkaF AlenkaF added this to the 13.0.0 milestone May 16, 2023
jorisvandenbossche pushed a commit that referenced this issue Jun 1, 2023
@AlenkaF
GH-35609: [Docs] Enable the build of subsections of the documentation (…
c67fb39 
…#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
- added info about the new make commands
* Closes: #35609

Lead-authored-by: Alenka Frim <frim.alenka@gmail.com>
Co-authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@AlenkaF AlenkaF mentioned this issue Jun 5, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AlenkaF AlenkaF

Labels
Component: Documentation Type: enhancement
Projects
None yet
Milestone
13.0.0
Development

Successfully merging a pull request may close this issue.

GH-35609: [Docs] Enable the build of subsections of the documentation AlenkaF/arrow
1 participant
@AlenkaF