Skip to content

Commit

Permalink
fix(docs): new domain and SEO
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoDelatte committed Dec 27, 2023
1 parent 011e043 commit 912b086
Show file tree
Hide file tree
Showing 13 changed files with 56 additions and 56 deletions.
16 changes: 9 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
.. _Black: https://github.com/psf/black

.. |CI/CD| image:: https://img.shields.io/github/actions/workflow/status/sktime/sktime/wheels.yml?logo=github
.. |CI/CD| image:: https://img.shields.io/github/actions/workflow/status/skfolio/skfolio/release.yml?logo=github
.. _CI/CD: https://github.com/skfolio/skfolio/raw/main/LICENSE


Expand All @@ -34,24 +34,26 @@
===============
|icon| skfolio
===============
.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/logo.ico
.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/favicon.png
:width: 100
:target: https://skfolio.github.io/skfolio/
:alt: skfolio documentation
:target: https://skfolio.org/


**skfolio** is a Python library for portfolio optimization built on top of scikit-learn.
It provides a unified interface and `sklearn` compatible tools to build, tune and
cross-validate portfolio models. It is distributed under the 3-Clause BSD license.

.. image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/expo.jpg
:target: https://skfolio.github.io/skfolio/auto_examples/
:target: https://skfolio.org/auto_examples/
:alt: examples

Important links
~~~~~~~~~~~~~~~

- Documentation: https://skfolio.github.io/skfolio/
- Examples: https://skfolio.github.io/skfolio/auto_examples/
- User Guide: https://skfolio.github.io/skfolio/user_guide/
- Documentation: https://skfolio.org/
- Examples: https://skfolio.org/auto_examples/
- User Guide: https://skfolio.org/user_guide/
- GitHub Repo: https://github.com/skfolio/skfolio/

Installation
Expand Down
Binary file removed docs/_static/android-chrome-192x192.png
Binary file not shown.
Binary file removed docs/_static/android-chrome-512x512.png
Binary file not shown.
Binary file removed docs/_static/apple-touch-icon.png
Binary file not shown.
Binary file removed docs/_static/favicon-16x16.png
Binary file not shown.
Binary file removed docs/_static/favicon-32x32.png
Binary file not shown.
Binary file added docs/_static/favicon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/_static/favicon.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/logo.ico
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_static/logo.svg

This file was deleted.

78 changes: 32 additions & 46 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
"sphinx-prompt",
"sphinx.ext.mathjax",
"sphinxext.opengraph",
"sphinx_sitemap"
"sphinx_sitemap",
"sphinx.ext.githubpages"
]

# Produce `plot::` directives for examples that contain `import matplotlib` or
Expand Down Expand Up @@ -100,16 +101,17 @@

# -- sphinxext-opengraph ----------------------------------------------------

ogp_site_url = "https://skfolio.github.io/skfolio"
ogp_image = "https://skfolio.github.io/skfolio/_images/expo.jpg"
ogp_site_url = "https://skfolio.org/"
ogp_site_name = "skfolio"
ogp_image = "https://skfolio.org/_images/expo.jpg"
ogp_enable_meta_description = True

# -- autosummary -------------------------------------------------------------

autosummary_generate = True

# -- sphinx_sitemap -------------------------------------------------------------
html_baseurl = 'https://skfolio.github.io/skfolio/'
html_baseurl = 'https://skfolio.org/'
sitemap_url_scheme = "{link}"

# -- Internationalization ----------------------------------------------------
Expand All @@ -127,8 +129,6 @@
# -- Options for HTML output -------------------------------------------------

html_theme = "pydata_sphinx_theme"
html_logo = "_static/logo.svg"
html_favicon = "_static/logo.svg"
html_sourcelink_suffix = ""

# Define the version we use for matching in the version switcher.
Expand All @@ -149,7 +149,9 @@
],
"logo": {
"text": "skfolio",
"alt_text": "skfolio",
"alt_text": "skfolio documentation - Home",
"image_light": "_static/favicon.svg",
"image_dark": "_static/favicon.svg",
},
# "use_edit_page_button": True,
"show_toc_level": 1,
Expand All @@ -160,19 +162,27 @@
If you'd like to contribute,
<a href="https://github.com/skfolio/skfolio">check out our GitHub repository.</a>
Your contributions are welcome!</div>""",
# "show_nav_level": 2,
# "navbar_start": ["navbar-logo"],
# "navbar_end": ["theme-switcher", "navbar-icon-links"],
# "navbar_persistent": ["search-button"],
# "primary_sidebar_end": ["custom-template.html", "sidebar-ethical-ads.html"],
# "article_footer_items": ["test.html", "test.html"],
# "content_footer_items": ["test.html", "test.html"],
# "footer_start": ["test.html", "test.html"],
"secondary_sidebar_items": [], # No secondary sidebar due to bug with plotly
# "switcher": {
# "json_url": json_url,
# "version_match": version_match,
# },
"favicons": [
{
"rel": "shortcut icon",
"type": "image/svg+xml",
"sizes": "any",
"href": "favicon.svg",
},
{
"rel": "icon",
"type": "image/svg+xml",
"sizes": "any",
"href": "favicon.svg",
},
{
"rel": "icon",
"type": "image/png",
"sizes": "144x144",
"href": "favicon.png",
},
]
}

html_sidebars = {
Expand All @@ -184,17 +194,13 @@
html_show_sourcelink = False

html_context = {
"github_user": "HugoDelatte",
"github_repo": "portfolio-optimization",
"github_user": "skfolio",
"github_repo": "skfolio",
"github_version": "main",
"doc_path": "doc",
"doc_path": "docs",
"default_mode": "dark",
}

rediraffe_redirects = {
"contributing.rst": "community/index.rst",
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand All @@ -203,26 +209,6 @@
# html_js_files = ["custom-icon.js"]
# todo_include_todos = True

# -- favicon options ---------------------------------------------------------

# see https://sphinx-favicon.readthedocs.io for more information about the
# sphinx-favicon extension
favicons = [
# generic icons compatible with most browsers
"favicon-32x32.png",
"favicon-16x16.png",
{"rel": "shortcut icon", "sizes": "any", "href": "favicon.ico"},
# chrome specific
"android-chrome-192x192.png",
# apple icons
{"rel": "mask-icon", "color": "#459db9", "href": "safari-pinned-tab.svg"},
{"rel": "apple-touch-icon", "href": "apple-touch-icon.png"},
# msapplications
{"name": "msapplication-TileColor", "content": "#459db9"},
{"name": "theme-color", "content": "#ffffff"},
{"name": "msapplication-TileImage", "content": "mstile-150x150.png"},
]

# -- gallery ----------------------------------------------------------------

image_scrapers = (
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ It provides a unified interface and `sklearn` compatible tools to build, tune an
cross-validate portfolio models.

.. image:: _static/expo.jpg
:target: https://skfolio.github.io/skfolio/auto_examples/
:target: https://skfolio.org/auto_examples/
:alt: examples


Installation
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ docs = [
"sphinx-favicon",
"sphinx-prompt",
"sphinxext.opengraph",
"sphinx-sitemap"
"sphinx-sitemap",
"sphinx-favicon"
]

[project.urls]
Expand Down

0 comments on commit 912b086

Please sign in to comment.