navbar links now accept relative and absolute links instead of absolu…

…te only #15
Thecarisma · Sep 12, 2020 · f1acf57 · f1acf57
1 parent 0cd48d6
commit f1acf57
Show file tree

Hide file tree

Showing 21 changed files with 246 additions and 50 deletions.
diff --git a/docs/clear/conf.rst b/docs/clear/conf.rst
@@ -39,5 +39,24 @@ The **conf.py** file that generates this documentation.
             'otherpages/rightpage'
         ],
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/clear/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/fandango/conf.rst b/docs/fandango/conf.rst
@@ -55,6 +55,12 @@ The **conf.py** file that generates this documentation.
                 ]
             }
         ],
+        'navbar_links': [
+            ('Twitter', 'https://twitter.com/iamthecarisma'),
+            ('Github', 'https://github.com/Thecarisma/themata/'),
+            ("Introduction", "general/introduction"),
+            ("FAQ", "general/faq")
+        ],
         'social_icons': [
             ('fab fa-twitter', 'https://twitter.com/iamthecarisma'),
             ('fab fa-github', 'https://github.com/Thecarisma/themata/')
@@ -72,5 +78,24 @@ The **conf.py** file that generates this documentation.
             'singlepage'
         ],
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/fandango/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/fluid/conf.rst b/docs/fluid/conf.rst
@@ -24,7 +24,9 @@ The **conf.py** file that generates this documentation.
         'collapsible_sidebar_display': 'block',
         'navbar_links': [
             ('Twitter', 'https://twitter.com/iamthecarisma'),
-            ('Github', 'https://github.com/Thecarisma/themata/')
+            ('Github', 'https://github.com/Thecarisma/themata/'),
+            ("Introduction", "general/introduction"),
+            ("FAQ", "general/faq")
         ],
         'has_left_sidebar': True,
         'has_right_sidebar': True,
@@ -71,5 +73,24 @@ The **conf.py** file that generates this documentation.
             'otherpages/rightpage'
         ],
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/fluid/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/garri/conf.rst b/docs/garri/conf.rst
@@ -26,5 +26,24 @@ The **conf.py** file that generates this documentation.
         ],
         'toc_title': 'Other Topics',
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/garri/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/hackish/conf.rst b/docs/hackish/conf.rst
@@ -22,7 +22,9 @@ The **conf.py** file that generates this documentation.
         'show_navigators_in_index': False,
         'navbar_links': [
             ('Twitter', 'https://twitter.com/iamthecarisma'),
-            ('Github', 'https://github.com/Thecarisma/themata/')
+            ('Github', 'https://github.com/Thecarisma/themata/'),
+            ("Introduction", "general/introduction"),
+            ("FAQ", "general/faq")
         ],
         'has_left_sidebar': True,
         'show_navigators': True,
@@ -66,5 +68,24 @@ The **conf.py** file that generates this documentation.
         ],
         'toc_title': 'Other Topics',
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/hackish/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/milkish/conf.rst b/docs/milkish/conf.rst
@@ -24,7 +24,9 @@ The **conf.py** file that generates this documentation.
         'collapsible_sidebar_display': 'block',
         'navbar_links': [
             ('Twitter', 'https://twitter.com/iamthecarisma'),
-            ('Github', 'https://github.com/Thecarisma/themata/')
+            ('Github', 'https://github.com/Thecarisma/themata/'),
+            ("Introduction", "general/introduction"),
+            ("FAQ", "general/faq")
         ],
         'has_left_sidebar': True,
         'has_right_sidebar': True,
@@ -71,5 +73,24 @@ The **conf.py** file that generates this documentation.
             'otherpages/rightpage'
         ],
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/milkish/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/sugar/conf.rst b/docs/sugar/conf.rst
@@ -24,7 +24,9 @@ The **conf.py** file that generates this documentation.
         'collapsible_sidebar_display': 'block',
         'navbar_links': [
             ('Twitter', 'https://twitter.com/iamthecarisma'),
-            ('Github', 'https://github.com/Thecarisma/themata/')
+            ('Github', 'https://github.com/Thecarisma/themata/'),
+            ("Introduction", "general/introduction"),
+            ("FAQ", "general/faq")
         ],
         'navbar_sec_links': [
             ('Twitter', 'https://twitter.com/iamthecarisma'),
@@ -75,5 +77,24 @@ The **conf.py** file that generates this documentation.
             'otherpages/rightpage'
         ],
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/sugar/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/docs/water/conf.rst b/docs/water/conf.rst
@@ -22,7 +22,9 @@ The **conf.py** file that generates this documentation.
         'show_navigators_in_index': False,
         'navbar_links': [
             ('Twitter', 'https://twitter.com/iamthecarisma'),
-            ('Github', 'https://github.com/Thecarisma/themata/')
+            ('Github', 'https://github.com/Thecarisma/themata/'),
+            ("Introduction", "general/introduction"),
+            ("FAQ", "general/faq")
         ],
         'has_left_sidebar': True,
         'show_navigators': True,
@@ -65,5 +67,24 @@ The **conf.py** file that generates this documentation.
             'otherpages/singlepage'
         ],
         'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/water/',
-        'source_root_edit_text': 'Edit on Github'
+        'source_root_edit_text': 'Edit on Github',
+        'metadata': {
+            "enable": True,
+            "url": "https://thecarisma.github.io/themata",
+            "type": "website",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
+            "author": "Adewale Azeez"
+        },
+        'twitter_metadata': {
+            "enable": True,
+            "card": "summary",
+            "site": "@iamthecarisma",
+            "creator": "@iamthecarisma",
+            "title": "Set of Highly customizable sphinx themes.",
+            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
+            "image": "https://github.com/raw/Thecarisma/themata/main/docs/images/themata.small.png",
+        }
     }
diff --git a/test/confs/fandango.conf.py b/test/confs/fandango.conf.py
@@ -32,10 +32,10 @@
         "singlepage"
     ],
     'navbar_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'social_icons': [
         ("fab fa-twitter", "https://twitter.com/iamthecarisma"),

diff --git a/test/confs/fluid.conf.py b/test/confs/fluid.conf.py
@@ -31,10 +31,10 @@
         "singlepage"
     ],
     'navbar_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'social_icons': [
         ("fab fa-twitter", "https://twitter.com/iamthecarisma"),

diff --git a/test/confs/hackish.conf.py b/test/confs/hackish.conf.py
@@ -26,10 +26,10 @@
         "singlepage"
     ],
     'navbar_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'social_icons': [
         ("fab fa-twitter", "https://twitter.com/iamthecarisma"),

diff --git a/test/confs/milkish.conf.py b/test/confs/milkish.conf.py
@@ -30,10 +30,10 @@
         "singlepage"
     ],
     'navbar_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'social_icons': [
         ("fab fa-twitter", "https://twitter.com/iamthecarisma"),

diff --git a/test/confs/sugar.conf.py b/test/confs/sugar.conf.py
@@ -30,16 +30,16 @@
         "singlepage"
     ],
     'navbar_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'navbar_sec_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'social_icons': [
         ("fab fa-twitter", "https://twitter.com/iamthecarisma"),

diff --git a/test/confs/water.conf.py b/test/confs/water.conf.py
@@ -26,10 +26,10 @@
         "singlepage"
     ],
     'navbar_links': [
-        ("Docs", "./docs"),
-        ("Download", "https://pypi.python.org/pypi/milkish"),
-        ("Examples", "./examples"),
-        ("FAQ", "./faq")
+        ("General", "general/index"),
+        ("Download", "https://pypi.python.org/pypi/themata"),
+        ("Introduction", "general/introduction"),
+        ("FAQ", "general/faq")
     ],
     'social_icons': [
         ("fab fa-twitter", "https://twitter.com/iamthecarisma"),

diff --git a/test/test_rst/index.rst b/test/test_rst/index.rst
@@ -34,7 +34,7 @@ Sphinx’s basic theme provides base templates with a couple of blocks it will f
 
 For example, to add a new link to the template area containing related links all you have to do is to add a new template called layout.html with the following contents:
 
-.. image:: https://github.com/Thecarisma/themata/raw/master/docs/images/themata.png
+.. image:: https://github.com/Thecarisma/themata/raw/main/docs/images/themata.png
     :alt: About to make the tackle, Yale Alumni Game 2017
     :align: center