Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

DOC: update doc/readme.txt & remove devel/readme#27631

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timhoffm merged 1 commit intomatplotlib:mainfromstory645:doc-readme
Feb 5, 2024

Conversation

@story645
Copy link
Member

@story645story645 commentedJan 10, 2024•
edited
Loading

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

@story645story645force-pushed thedoc-readme branch 3 times, most recently fromb81a52d tod70558cCompareJanuary 10, 2024 23:34
@github-actionsgithub-actionsbot added Documentation: buildbuilding the docs Documentation: devdocsfiles in doc/devel labelsFeb 4, 2024
@github-actionsgithub-actionsbot removed the Documentation: buildbuilding the docs labelFeb 4, 2024
@story645story645 changed the titleDOC: updated doc/readme.txt to current layoutDOC: updated doc/readme.txt to current layout, remove devel/readmeFeb 4, 2024
@story645story645 changed the titleDOC: updated doc/readme.txt to current layout, remove devel/readmeDOC: update doc/readme.txt & remove devel/readmeFeb 4, 2024
@story645story645force-pushed thedoc-readme branch 2 times, most recently frombec4f73 tod501b1cCompareFebruary 4, 2024 17:44
Content Folders
^^^^^^^^^^^^^^^

* api - placeholders to automatically generate the api documentation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Maybe

Suggested change
* api -placeholders to automatically generate the api documentation
* api -source files to automatically generate the api documentation

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think they're templates?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Works for me, though they are not templates in the same sense as_templates.

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:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

so my concern w/ a bullet list is tripping up source and target

deleted doc/devel/readme.txt because gitwash is no longer usedCo-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@timhoffmtimhoffm merged commit771fb38 intomatplotlib:mainFeb 5, 2024
@story645story645 deleted the doc-readme branchFebruary 5, 2024 15:48
@QuLogicQuLogic added this to thev3.9.0 milestoneJun 5, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@timhoffmtimhoffmtimhoffm approved these changes

Assignees

No one assigned

Projects

None yet

Milestone

v3.9.0

Development

Successfully merging this pull request may close these issues.

3 participants

@story645@timhoffm@QuLogic
[8]ページ先頭
©2009-2025 Movatter.jp