Simplify doc build process by removing empty directories locally #38185
Conversation
kwankyu
changed the title
|
Documentation preview for this PR (built with commit cb0da58; changes) is ready! 🎉 |
sagemathgh-38185: Simplify doc build process by removing empty directories locally <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> and thus hopefully fixes the mysterious issue sagemath#37858 (comment). ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies sagemath#37858 <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38185 Reported by: Kwankyu Lee Reviewer(s):
sagemathgh-38185: Simplify doc build process by removing empty directories locally <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> and thus hopefully fixes the mysterious issue sagemath#37858 (comment). ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies sagemath#37858 <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38185 Reported by: Kwankyu Lee Reviewer(s):
|
Edit: wrong ticket, this is from #37430 |
|
Needs work because it has #37858 merged in |
github-actions
bot
added
s: needs review
and removed
s: positive review
s: needs work
labels
kwankyu
force-pushed
the
p/locally-remove-empty-directory
branch
from
f394ce2 to
e254137
Compare
kwankyu
force-pushed
the
p/locally-remove-empty-directory
branch
from
160fb3a to
a50dc92
Compare
|
This PR is now separate from #37858. Back to positive review? |
kwankyu
force-pushed
the
p/locally-remove-empty-directory
branch
from
a50dc92 to
cb0da58
Compare
|
Has the code that removes empty directories been merged already? |
|
Before this PR, empty directories in all docs (each of them is a sphinx project) are removed at the same time when references (BIBLIO in src/doc/Makefile, one particular sphinx project) is made. This approach works but violates , well, the principle of separation of concerns(?). With this PR, empty directories in each doc are removed when that doc is made. So one sphinx project does not touch empty directories in governance of another sphinx project. This approach also works and looks better. |
|
Right, that's what I understood from the PR description, but in the diff I only see that |
|
In the phase of building inventory, |
|
Thanks! |
Now doc builder removes empty directories only in its own source directory.
📝 Checklist
⌛ Dependencies