-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrating to the PyData theme for the online docs (#576)
* docs: initial theme change * docs: first restructuring of menu of sphinx docs * fix: add theme to requirements * docs: added description to Reference page * docs: fixed link to tutorials * fix: minor fixes in online docs * docs: added back contributors * docs: fix typo + better installing page * fix: added back missing api sections * style: black * docs: added link to ref for loading function * response to review * docs: added button to new release and release notes * fix: button * docs: moved Using XGI to toc * doocs: add using xgi to to menu
- Loading branch information
1 parent
7335eca
commit 851460b
Showing
17 changed files
with
572 additions
and
141 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _recipes: | ||
|
||
################## | ||
Recipes | ||
################## | ||
|
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
.. _indepth_tutorials: | ||
|
||
|
||
################## | ||
In Depth tutorials | ||
################## | ||
|
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,189 @@ | ||
.. _contribute: | ||
|
||
**************** | ||
Development | ||
**************** | ||
|
||
|
||
Contribute | ||
========== | ||
|
||
If you want to contribute to this project, please make sure to read the | ||
`contributing guidelines <https://github.com/xgi-org/xgi/blob/main/HOW_TO_CONTRIBUTE.md>`_. | ||
We expect respectful and kind interactions by all contributors and users | ||
as laid out in our `code of conduct <https://github.com/xgi-org/xgi/blob/main/CODE_OF_CONDUCT.md>`_. | ||
|
||
The XGI community always welcomes contributions, no matter how small. | ||
We're happy to help troubleshoot XGI issues you run into, | ||
assist you if you would like to add functionality or fixes to the codebase, | ||
or answer any questions you may have. | ||
|
||
Some concrete ways that you can get involved: | ||
|
||
* **Get XGI updates** by following the XGI `Twitter <https://twitter.com/xginets>`_ account, signing up for our `mailing list <http://eepurl.com/igE6ez>`_, or starring this repository. | ||
* **Spread the word** when you use XGI by sharing with your colleagues and friends. | ||
* **Request a new feature or report a bug** by raising a `new issue <https://github.com/xgi-org/xgi/issues/new>`_. | ||
* **Create a Pull Request (PR)** to address an `open issue <https://github.com/xgi-org/xgi/issues>`_ or add a feature. | ||
* **Join our Zulip channel** to be a part of the `daily goings-on of XGI <https://xgi.zulipchat.com/join/7agfwo7dh7jo56ppnk5kc23r/>`_. | ||
|
||
|
||
Contributors | ||
============ | ||
|
||
The XGI project has been helped by invaluable contributions from many members of the community. All listings are alphabetical. | ||
|
||
Core team | ||
--------- | ||
|
||
.. raw:: html | ||
|
||
<p> | ||
<img src="https://github.com/acuschwarze.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/acuschwarze">@acuschwarze</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/alpatania.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/alpatania">@alpatania</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/iaciac.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/iaciac">@iaciac</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/leotrs.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/leotrs">@leotrs</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/lordgrilo.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/lordgrilo">@lordgrilo</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/maximelucas.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/maximelucas">@maximelucas</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/nwlandry.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/nwlandry">@nwlandry</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/tlarock.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/tlarock">@tlarock</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/thomasrobiglio.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/thomasrobiglio">@thomasrobiglio</a> | ||
</p> | ||
|
||
|
||
Core team alumni | ||
---------------- | ||
|
||
.. raw:: html | ||
|
||
<p> | ||
<img src="https://github.com/mcontisc.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/mcontisc">@mcontisc</a> | ||
</p> | ||
|
||
Contributors | ||
------------ | ||
|
||
.. raw:: html | ||
|
||
<p> | ||
<img src="https://github.com/acombretrenouard.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/acombretrenouard">@acombretrenouard</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/aleable.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/aleable">@aleable</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/arnaudon.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/arnaudon">@arnaudon</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/colltoaction.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/colltoaction">@colltoaction</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/doabell.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/doabell">@doabell</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/goznalo-git.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/goznalo-git">@goznalo-git</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/marconurisso.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/marconurisso">@marconurisso</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/pgberlureau.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/pgberlureau">@pgberlureau</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/pietrotraversa.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/pietrotraversa">@pietrotraversa</a> | ||
</p> | ||
|
||
<p> | ||
<img src="https://github.com/saad1282.png" | ||
width="50" height="50" hspace="5" | ||
style="border-radius: 50%; vertical-align: middle;"/> | ||
<a href="https://github.com/saad1282">@saad1282</a> | ||
</p> |
This file contains 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
Oops, something went wrong.