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: Merged duplicate README and index sections#1205

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

Open
ZviBaratz wants to merge5 commits intonipy:master
base:master
Choose a base branch
Loading
fromZviBaratz:doc/dup

Conversation

@ZviBaratz
Copy link
Contributor

Resolves#1204.

@codecov
Copy link

codecovbot commentedFeb 21, 2023
edited
Loading

Codecov Report

Patch coverage has no change and project coverage change:-0.01⚠️

Comparison is base(cbd7690) 92.16% compared to head(80d964e) 92.15%.

❗ Current head80d964e differs from pull request most recent headdf741f3. Consider uploading reports for the commitdf741f3 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@##           master    #1205      +/-   ##==========================================- Coverage   92.16%   92.15%   -0.01%==========================================  Files          97       97                Lines       12332    12334       +2       Branches     2534     2534              ==========================================+ Hits        11366    11367       +1  Misses        645      645- Partials      321      322       +1
Impacted FilesCoverage Δ
nibabel/info.py100.00% <ø> (ø)

... and6 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell ushow you rate us. Have a feature suggestion?Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment?Let us know in this issue.

@effigies
Copy link
Member

Okay, so it looks like the reason things ended up like this is that there's no way to unify reference links like:ref:`heading` and `text <heading>`_ in Sphinx. We could do something like manually dereference solinks_names.rst contains something like:

.. _appendix of the manual:./legal.html#license.. _installation:./installation.html#installation

And README.rst could have:

.. _appendix of the manual:https://nipy.org/nibabel/legal.html#license.. _installation:https://nipy.org/nibabel/installation.html#installation

It's not great, but we don't really reorganize much.

@ZviBaratz
Copy link
ContributorAuthor

ZviBaratz commentedFeb 25, 2023
edited
Loading

Sorry if I'm missing something, but couldn't we just use the second option anywhere there's a:ref:?
E.g., we could replace:

*:ref:`User Documentation<manual>` (manual)

with:

* `User Documentation<manual>`_ (manual)

and include:

.. _manual:https://nipy.org/nibabel/manual.html#manual

inlinks_names.txt?

Also, seems to me like the content in parentheses under theDocumentation heading could be removed for a cleaner look.

EDIT: Actually, where do you find this to be a problem? I don't see anything wrong looking at my local build.

@effigies
Copy link
Member

The reason not to use an absolute URL inlinks_names.rst is so that the link stays within site for testing. Right now if I test withpython -m http.server -d build, I gethttps://nipy.org/nibabel/legal.html instead ofhttp://0.0.0.0:8000/legal.html. If for some reason we moved things around, we wouldn't see the breakage until we uploaded the docs togh-pages.

@ZviBaratz
Copy link
ContributorAuthor

@effigies please see the proposed changes. Hope I understood correctly.

@effigieseffigies mentioned this pull requestDec 3, 2023
15 tasks
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@effigieseffigiesAwaiting requested review from effigies

Assignees

No one assigned

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Duplicate sections in the documentation site

2 participants

@ZviBaratz@effigies

[8]ページ先頭

©2009-2025 Movatter.jp