8000 DOC Remove redundant toctree in gallery header (#872) by Fyrebright · Pull Request #873 · fairlearn/fairlearn · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

DOC Remove redundant toctree in gallery header (#872) #873

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2021

Conversation

Fyrebright
Copy link
Contributor

The left example navbar is now autogenerated by sphinx-gallery so leaving this section is causing duplicates in the navbar.

The left example navbar is now autogenerated by sphinx-gallery so leaving this section  is causing duplicates in the navbar.
@hildeweerts hildeweerts requested a review from romanlutz June 23, 2021 14:38
@romanlutz
Copy link
8000
Member

@Fyrebright thanks for the PR! Could you post a screenshot of what it looks like now?

@Fyrebright
Copy link
Contributor Author

page

The problem was the toctree was defined by the auto and by README.rst. I realized that I didn't clarify if the table of contents in the body was supposed to remain now since the gallery is there. Is this the case? The problem with the autogenerated is that it marks each toctree as :hidden: so that it won't show in the body of the page and I haven't found a way to stop it from doing so.

@hildeweerts
Copy link
Contributor

I expected the list to disappear from the body so for me this is perfect @Fyrebright! Just to be sure: the build you're showing was created using make doc command right, not multi-version (because the version selection is missing)?

If @romanlutz agrees as well I am happy to merge.

Copy link
Member
@romanlutz romanlutz left a comment

Choose a reason for hiding this comment

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

Thanks for adding the screenshot! This looks fine. Good to know we don't need to manually maintain the toctree.

@romanlutz romanlutz changed the title [DOC] Remove redundant toctree in gallery header (#872) DOC Remove redundant toctree in gallery header (#872) Jun 25, 2021
@romanlutz romanlutz merged commit 706ff7f into fairlearn:main Jun 25, 2021
romanlutz pushed a commit to romanlutz/fairlearn that referenced this pull request Jul 2, 2021
…earn#873)

The left example navbar is now autogenerated by sphinx-gallery so leaving this section  is causing duplicates in the navbar.
romanlutz pushed a commit that referenced this pull request Jul 6, 2021
* DOC Extend documentation for plotting functionality (#806)

* Extend documentation for plotting functionality

Issue #802

* Use literalinclude instead of codeblock

* Extend documentation for plotting functionality

Issue #802

* Use literalinclude instead of codeblock

* fix header underline and remove duplicate sections

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* avoid showing customized plot code in quickstart

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* Update docs/user_guide/assessment.rst

Co-authored-by: Hilde Weerts <24417440+hildeweerts@users.noreply.github.com>

* Update docs/user_guide/assessment.rst

Co-authored-by: Hilde Weerts <24417440+hildeweerts@users.noreply.github.com>

Co-authored-by: Roman Lutz <rolutz@microsoft.com>
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Hilde Weerts <24417440+hildeweerts@users.noreply.github.com>

* DOC: Change year dynamically in sphinx docs (#871)

Signed-off-by: kurianbenoy-aot <kurian.benoy@aot-technologies.com>

Co-authored-by: kurianbenoy-aot <kurian.benoy@aot-technologies.com>

* DOC: Construct Validity Glossary (main)  (#787)

* PP Study - No flake8 issues besides those generated by Sphinx (line too long, blank line required between summary and description, missing docstring)

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* Message

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* Message

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* Message

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* Message

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* Message

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* Message

Signed-off-by: Michael Amoako <miamoako@microsoft.com>

* This is intended (romanlutz)

* trying to build AI systems (hildeweerts)

* new sociotechnical context definition (hildeweerts)

* links where paper title referenced (romanlutz)

* does->do (romanlutz)

* the extent to which the measurement model measures the intended construct in way that is meaningful and useful (hildeweerts)

* Updated: gap between fairness and demographic parityclosed, reference to fairlearn metrics fixed

* Added related example of patient benefit (rolutz)

* Pass through for initial commit

* MM Requested change (intro)

* DOC Remove redundant toctree in gallery header (#872) (#873)

The left example navbar is now autogenerated by sphinx-gallery so leaving this section  is causing duplicates in the navbar.

* DOC Add note about MetricFrame CSV export (#875)

* Fixing links

Signed-off-by: Richard Edgar <riedgar@microsoft.com>

* Rephrase and add a couple more details

Signed-off-by: Richard Edgar <riedgar@microsoft.com>

* Keep flake8 happy

Signed-off-by: Richard Edgar <riedgar@microsoft.com>

* FIX create utils module (#878)

* version updates for 0.7.0 (#868)

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* add __init__.py file

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* create utils module with input validation

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* undo versioning changes

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* flake8

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* Update fairlearn/reductions/_moments/utility_parity.py

Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>

* Update fairlearn/utils/__init__.py

Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>

* Update test/unit/postprocessing/test_threshold_optimization.py

Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>

* flake8

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

* flake8

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>

* adjust precision to 1e-5 (#883)

Signed-off-by: Roman Lutz <rolutz@microsoft.com>

Co-authored-by: Brenda Thng <52529078+bthng@users.noreply.github.com>
Co-authored-by: Hilde Weerts <24417440+hildeweerts@users.noreply.github.com>
Co-authored-by: Kurian Benoy <kurian.bkk@gmail.com>
Co-authored-by: kurianbenoy-aot <kurian.benoy@aot-technologies.com>
Co-authored-by: Michael Amoako <miamoako@microsoft.com>
Co-authored-by: Fyrebright <aidcostello@gmail.com>
Co-authored-by: Richard Edgar <riedgar@microsoft.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0