DOC: update doc/readme.txt & remove devel/readme #27631
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
b81a52d to
d70558c
Compare
bec4f73 to
d501b1c
Compare
timhoffm
reviewed
Feb 5, 2024
doc/README.txt
Outdated
| Content Folders | ||
| ^^^^^^^^^^^^^^^ | ||
|
|
||
| * api - placeholders to automatically generate the api documentation |
There was a problem hiding this comment.
Maybe
Suggested change
| * api - placeholders to automatically generate the api documentation | |
| * api - source files to automatically generate the api documentation |
There was a problem hiding this comment.
I think they're templates?
There was a problem hiding this comment.
Works for me, though they are not templates in the same sense as _templates.
doc/README.txt
Outdated
| During the documentation build, sphinx-gallery creates symlinks from the source folders | ||
| in `/galleries` to target_folders in '/doc'; therefore ensure that you are editing the | ||
| real files rather than the symbolic links: | ||
|
|
There was a problem hiding this comment.
I find the table format quite noisy. Would you consider a simple table or a bullet list? If you rather keep the fully outlined table, please separate header and content using = signs.
There was a problem hiding this comment.
so my concern w/ a bullet list is tripping up source and target
deleted doc/devel/readme.txt because gitwash is no longer used Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
approved these changes
Feb 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
The doc/readme.txt got kinda out of sync w/ the current state of the docs, so I updated it to describe what I think is current state. Waiting on #27560 to spare a rebase there.
Also deleted doc/devel/readme since gitwash was removed in #23588
PR checklist