Skip to content
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

[DOC] add links and edit buttons to doc #3964

Merged
merged 6 commits into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 20 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,28 @@
:alt: PyPI - Python Version

.. image:: https://github.com/nilearn/nilearn/workflows/build/badge.svg?branch=main&event=push
:target: https://github.com/nilearn/nilearn/actions
:alt: Github Actions Build Status
:target: https://github.com/nilearn/nilearn/actions
:alt: Github Actions Build Status

.. image:: https://codecov.io/gh/nilearn/nilearn/branch/main/graph/badge.svg
:target: https://codecov.io/gh/nilearn/nilearn
:alt: Coverage Status
:target: https://codecov.io/gh/nilearn/nilearn
:alt: Coverage Status

.. image:: http://img.shields.io/twitter/follow/nilearn.svg
:target: https://twitter.com/nilearn
:alt: Twitter

.. image:: https://img.shields.io/mastodon/follow/109669703955432270?domain=https%3A%2F%2Ffosstodon.org%2F
:target: https://fosstodon.org/@nilearn
:alt: Mastodon

.. image:: https://img.shields.io/discord/711993354929569843
:target: https://discord.gg/SsQABEJHkZ
:alt: Discord





nilearn
=======
Expand Down
35 changes: 34 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@

# General information about the project.
project = "Nilearn"
copyright = "The nilearn developers 2010-2022"
copyright = "The nilearn developers 2010-2023"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -168,12 +168,16 @@
html_theme = "furo"

# Add custom css instructions from themes/custom.css
font_awesome = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/"
html_css_files = [
"custom.css",
(
"https://cdnjs.cloudflare.com/ajax/libs/"
"font-awesome/5.15.4/css/all.min.css"
),
f"{font_awesome}fontawesome.min.css",
f"{font_awesome}solid.min.css",
f"{font_awesome}brands.min.css",
]

# The style sheet to use for HTML and HTML Help pages. A file of that name
Expand All @@ -197,6 +201,35 @@
"color-admonition-title--note": "#448aff",
"color-admonition-title-background--note": "#448aff10",
},
"source_repository": "https://github.com/nilearn/nilearn/",
"source_branch": "main",
"source_directory": "doc/",
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/nilearn/nilearn",
"html": "",
"class": "fa-brands fa-solid fa-github fa-2x",
},
{
"name": "Twitter",
"url": "https://twitter.com/nilearn",
"html": "",
"class": "fa-brands fa-solid fa-twitter fa-2x",
},
{
"name": "Mastodon",
"url": "https://fosstodon.org/@nilearn",
"html": "",
"class": "fa-brands fa-solid fa-mastodon fa-2x",
},
{
"name": "Discord",
"url": "https://discord.gg/SsQABEJHkZ",
"html": "",
"class": "fa-brands fa-solid fa-discord fa-2x",
},
],
}

# Add banner in case version is not stable
Expand Down