Skip to content

Commit c0e0dd7

Browse files
committed
RF: Comment fixes.
1 parent 4b87912 commit c0e0dd7

6 files changed

Lines changed: 18 additions & 10 deletions

File tree

docs/source/_extra/robots.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
User-agent: *
22
Allow: /
3+
Disallow: /dev/
4+
Disallow: /v*/
35

4-
Sitemap: https://fury.gl/sitemap.xml
6+
Sitemap: https://fury.gl/latest/sitemap.xml

docs/source/_templates/home.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
{% block extrahead %}
44
{# sphinxext-opengraph skips this page: it has no doctree, so the tags are set here. #}
55
<meta name="description" content="FURY - Free Unified Rendering in pYthon. A free and open-source software library for Scientific Visualization and 3D animations.">
6-
<meta name="keywords" content="FURY, Python, 3D rendering, scientific visualization, animation, simulation, graphics">
76
<meta property="og:type" content="website">
87
<meta property="og:title" content="FURY - Free Unified Rendering in pYthon">
98
<meta property="og:description" content="A free and open-source Python library for Scientific Visualization and 3D animations, GPU accelerated through pygfx and WebGPU.">
10-
<meta property="og:url" content="https://fury.gl/">
11-
<meta property="og:image" content="https://fury.gl/_static/images/text-logo.png">
9+
<meta property="og:url" content="{{ pageurl }}">
10+
<meta property="og:image" content="{{ pageurl }}_static/images/text-logo.png">
1211
<meta name="twitter:card" content="summary_large_image">
1312
<link rel="preconnect" href="https://fonts.googleapis.com">
1413
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

docs/source/conf.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,15 @@
6060
"sphinxext.opengraph",
6161
]
6262

63+
html_baseurl = os.environ.get("SPHINX_HTML_BASE_URL", "https://fury.gl/latest/")
64+
6365
# Open Graph configuration
64-
ogp_site_url = "https://fury.gl/"
65-
ogp_image = "https://fury.gl/_static/images/text-logo.png"
66+
ogp_site_url = html_baseurl
67+
ogp_image = html_baseurl + "_static/images/text-logo.png"
6668

67-
# Sitemap configuration. The docs are served at the root of html_baseurl, so the
68-
# default scheme's version/language prefixes are dropped. See _extra/robots.txt.
69+
# Sitemap configuration. html_baseurl already points at this build's own
70+
# deploy root (e.g. /dev/, /latest/, /vX.Y.x/), so the default scheme's
71+
# version/language prefixes are redundant and dropped. See _extra/robots.txt.
6972
sitemap_filename = "sitemap.xml"
7073
sitemap_url_scheme = "{link}"
7174
# Generated indexes and source views, of no value in search results.
@@ -193,7 +196,6 @@
193196
html_css_files = ["css/fury_theme.css"]
194197
html_additional_pages = {"index": "home.html"}
195198

196-
html_baseurl = os.environ.get("SPHINX_HTML_BASE_URL", "https://fury.gl/")
197199
html_extra_path = ["_extra"]
198200

199201
html_logo = "_static/images/logo.svg"

docs/source/getting_started.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Getting Started
33
===============
44

5+
.. meta::
6+
:description: A quick-start guide to building your first scientific visualization scene with FURY in Python.
7+
58
Start by importing FURY.
69

710
.. code-block:: python

docs/source/installation.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Installation
33
============
44

5+
.. meta::
6+
:description: Install FURY, the open-source Python library for scientific visualization and 3D animations, via pip or conda.
7+
58
FURY supports Python 3.5+. You can currently still use Python 2.7 but it will soon stop being supported as the Python 2.7 end of life is on December 31st 2019.
69

710
Dependencies

docs/source/introduction.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ About
44

55
.. meta::
66
:description: Discover FURY, a powerful Python library for advanced scientific visualization and 3D animations. Open-source, GPU-accelerated, and easy to use.
7-
:keywords: FURY, about FURY, scientific visualization library, 3D animations, GPU acceleration, Pythonic API
87

98
Overview
109
--------

0 commit comments

Comments
 (0)