xgi-org / xgi

CompleX Group Interactions (XGI) is a Python package for higher-order networks.
https://xgi.readthedocs.io
Other
172 stars 27 forks source link

Fixed sphinx errors #487

Closed nwlandry closed 8 months ago

nwlandry commented 8 months ago

I fixed a good majority of sphinx errors. I also changed the function names in the convert module to be consistent.

review-notebook-app[bot] commented 8 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

codecov[bot] commented 8 months ago

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (2eea477) 92.00% compared to head (638e09c) 91.89%. Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #487 +/- ## ========================================== - Coverage 92.00% 91.89% -0.12% ========================================== Files 60 60 Lines 4428 4441 +13 ========================================== + Hits 4074 4081 +7 - Misses 354 360 +6 ``` | [Files](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org) | Coverage Δ | | |---|---|---| | [xgi/convert/graph.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2NvbnZlcnQvZ3JhcGgucHk=) | `100.00% <100.00%> (ø)` | | | [xgi/core/dihypergraph.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2NvcmUvZGloeXBlcmdyYXBoLnB5) | `98.12% <100.00%> (ø)` | | | [xgi/core/diviews.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2NvcmUvZGl2aWV3cy5weQ==) | `83.60% <ø> (ø)` | | | [xgi/core/hypergraph.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2NvcmUvaHlwZXJncmFwaC5weQ==) | `93.54% <100.00%> (ø)` | | | [xgi/core/simplicialcomplex.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2NvcmUvc2ltcGxpY2lhbGNvbXBsZXgucHk=) | `85.66% <100.00%> (ø)` | | | [xgi/core/views.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2NvcmUvdmlld3MucHk=) | `94.11% <ø> (ø)` | | | [xgi/drawing/draw.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2RyYXdpbmcvZHJhdy5weQ==) | `76.90% <ø> (-1.04%)` | :arrow_down: | | [xgi/drawing/layout.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2RyYXdpbmcvbGF5b3V0LnB5) | `99.18% <100.00%> (ø)` | | | [xgi/generators/randomizing.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL2dlbmVyYXRvcnMvcmFuZG9taXppbmcucHk=) | `91.80% <ø> (ø)` | | | [xgi/stats/\_\_init\_\_.py](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org#diff-eGdpL3N0YXRzL19faW5pdF9fLnB5) | `85.46% <ø> (ø)` | | | ... and [5 more](https://app.codecov.io/gh/xgi-org/xgi/pull/487?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org) | | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/xgi-org/xgi/pull/487/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xgi-org)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

maximelucas commented 8 months ago

Thanks! And good idea for the renaming.

I noticed some links still aren't working in the online docs, page About and Index (the blue links):

Screenshot 2023-10-30 at 08 54 05

And the funding link does not seem to be working either "HNDS-I: Using Hypergraphs to Study Spreading Processes in Complex Social Networks.".

nwlandry commented 8 months ago

Thanks for the suggestions!! I fixed all the issues you raised and also removed any mention of the old tutorials location.

maximelucas commented 8 months ago

Looks good! Better to leave #485 for another PR right?

nwlandry commented 8 months ago

I think I might have fixed a good number of the broken links, but it needs a double-check. We can open a dedicated PR if necessary.