Reconfigure template

.github/workflows/deploy-blog.yaml

@@ -0,0 +1,40 @@
+name: deploy-blog
+
+# Only run this when the master branch changes
+on:
+  pull_request:
+  push:
+    branches:
+    - main
+  workflow_dispatch:
+
+# This job installs dependencies, build the blog, and pushes it to `gh-pages`
+jobs:
+  deploy-blog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+
+    # Install dependencies
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.x' 
+
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+
+    # Build the blog
+    - name: Build the site
+      run: |
+        ablog build
+
+    # If we've pushed to main, push the blog's HTML to github-pages
+    - if: ${{ github.ref == 'refs/heads/main' }}
+      name: GitHub Pages action
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./_website

.gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 _website
 .doctrees
+.venv

README.md

@@ -1,121 +0,0 @@
-<!-- PROJECT SHIELDS -->
-[![Contributors][contributors-shield]][contributors-url]
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
-
-<!-- PROJECT LOGO -->
-<br />
-<p align="center">
-  <a href="https://github.com/errbufferoverfl/ruby-hammerhead">
-    <img src="images/logo.png" alt="Logo" width="80" height="80">
-  </a>
-  <h3 align="center">Ruby Hammerhead</h3>
-<p align="center">
-A template repository for setting up your own Sphinx/ablog website using the Pydata Sphinx Theme.
-    <br/>
-    <a href="https://github.com/errbufferoverfl/ruby-hammerhead"><strong>Explore the docs »</strong></a>
-    <br/>
-    <br/>
-    <a href="https://errbufferoverfl.github.io/ruby-hammerhead/">View Demo</a>
-    ·
-    <a href="https://github.com/errbufferoverfl/ruby-hammerhead/issues">Report Bug</a>
-    ·
-    <a href="https://github.com/errbufferoverfl/ruby-hammerhead/issues">Request Feature</a>
-  </p>
-</p>
-
-<!-- TABLE OF CONTENTS -->
-
-* [About the Project](#about-the-project)
-  * [Built With](#built-with)
-* [Getting Started](#getting-started)
-  * [Making Changes](#making-changes)
-* [Acknowledgements](#acknowledgements)
-
-<!-- ABOUT THE PROJECT -->
-# About the Project
-[![Product Name Screen Shot][product-screenshot]](https://errbufferoverfl.github.io/ruby-hammerhead/)
-
-Getting yourself setup with Sphinx and ablog is pretty straight-forward using this repo!
-
-By default this installation will get you setup with a reStructuredText and Markdown parser, an extension for creating panels, grids, dropdowns and more, an extension so users can easily copy and paste your code snippets, as well as extension to generate `OpenGraph metadata <https://ogp.me/>`_. For more information about each of these components' checkout the `References </references/>`_.
-
-## Built With
-
-* [Sphinx Documentation](https://www.sphinx-doc.org/en/master/index.html)
-* [reStructuredText Primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
-* [ablog Documentation](https://ablog.readthedocs.io/)
-* [Pydata Documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/)
-* [Sphinx Design Documentation](https://sphinx-design.readthedocs.io/)
-
-<!-- GETTING STARTED -->
-# Getting Started
-
-The first thing you'll need to do is clone this repository locally using Git:
-
-```shell
-git clone https://github.com/errbufferoverfl/ruby-hammerhead.git
-```
-
-Next you'll need to install all the dependencies which are managed by Pipenv.
-
-**Tip:** Ruby Hammerhead uses Python 3.9, if you are using multiple versions of Python, I'd recommend checking out [asdf](https://github.com/asdf-vm/asdf) an extendable version manager with support for Python, Ruby, Node.js, Elixir, Erlang & more.
-
-```sh
-pipenv install
-```
-
-Run the default build, which will create a website that looks exactly like [the demo site](https://errbufferoverfl.github.io/ruby-hammerhead/).
-
-```sh
-ablog build && ablog serve
-```
-
-**Warning:** Many of the files located in kitchen sink include broken references, citations and hyperlinks to demonstrate what things will look like if incorrectly configured. If you're running your build for the first time and haven't deleted this directory, you can expect the following errors:
-
-```text
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:264: WARNING: Footnote [4] is not referenced.
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:270: WARNING: Footnote [11] is not referenced.
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:15: WARNING: Undefined substitution referenced: "problematic".
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:264: WARNING: Unknown target name: "5".
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:307: WARNING: Unknown target name: "body elements".
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:318: WARNING: Unknown target name: "hyperlink reference without a target".
-/ruby-hammerhead/kitchen-sink/paragraph-level-markup.rst:278: WARNING: citation not found: nonexistent
-```
-
-<!-- MAKING CHANGES -->
-## Making Changes
-
-While developing your blog & making changes, I recommend running `ablog clean` before building and serving to make sure you don't accidentally capture artifacts.
-
-```shell
-ablog clean && ablog build && ablog serve
-```
-
-You can also run `ablog clean -D` which does a deep clean, removing cached environment and doctree files.
-
-```shell
-ablog clean -D && ablog build && ablog serve
-```
-
-<!-- ACKNOWLEDGEMENTS -->
-# Acknowledgements
-
-* [Chris Holdgraf](https://github.com/choldgraf)
-
-<!-- MARKDOWN LINKS & IMAGES -->
-<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-[contributors-shield]: https://img.shields.io/github/contributors/errbufferoverfl/ruby-hammerhead.svg?style=flat-square
-[contributors-url]: https://github.com/errbufferoverfl/ruby-hammerhead/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/errbufferoverfl/ruby-hammerhead.svg?style=flat-square
-[forks-url]: https://github.com/errbufferoverfl/ruby-hammerhead/network/members
-[stars-shield]: https://img.shields.io/github/stars/errbufferoverfl/ruby-hammerhead.svg?style=flat-square
-[stars-url]: https://github.com/errbufferoverfl/ruby-hammerhead/stargazers
-[issues-shield]: https://img.shields.io/github/issues/errbufferoverfl/ruby-hammerhead.svg?style=flat-square
-[issues-url]: https://github.com/errbufferoverfl/ruby-hammerhead/issues
-[license-shield]: https://img.shields.io/github/license/errbufferoverfl/ruby-hammerhead.svg?style=flat-square
-[license-url]: https://github.com/errbufferoverfl/ruby-hammerhead/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/errbufferoverfl
-[product-screenshot]: images/screenshot.png

conf.py

@@ -17,29 +17,29 @@
 # -- Sphinx configuration ---------------------------------------------------
 
 # General information about the project.
-project = "Ruby Hammerhead"
-copyright = "2021, errbufferoverfl"
-author = "errbufferoverfl"
+project = "Salesforce Adriaan"
+copyright = "2024, Adriaan van Niekerk"
+author = "sfadriaan"
 
 # The full version, including alpha/beta/rc tags
-release = '1.1.0'
+release = ''
 
-html_baseurl = "https://errbufferoverfl.github.io/"
-html_title = "Ruby Hammerhead"
-timezone = "Melbourne/Australia"
+html_baseurl = "https://sfadriaan.github.io/"
+html_title = "Salesforce Adriaan"
+timezone = ""
 
 # -- Ablog configuration ---------------------------------------------------
 ablog_builder = "dirhtml"
 
 # Base URL for the website, required for generating feeds.
 # e.g. blog_baseurl = "http://example.com/"
-blog_baseurl = "https://errbufferoverfl.github.io/"
+blog_baseurl = "https://sfadriaan.github.io/"
 
 # A path relative to the configuration directory for posts archive pages.
 blog_path = "posts"
 
 # The "title" for the posts, used in active pages.  Default is ``'Blog'``.
-blog_title = "Ruby Hammerhead"
+blog_title = "Salesforce Adriaan"
 
 # The path that you store your content in, this will be used for the browsing path
 # on your published website
@@ -87,7 +87,6 @@
 # ones.
 extensions = [
     "ablog",
-    "myst_parser",
     "sphinx.ext.intersphinx",
     "sphinx_design",
     "sphinx_copybutton",
@@ -100,7 +99,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["README.md", "Pipfile", "Pipfile.lock", "Makefile", "make.bat", "logo.gif", "conf.py"]
+exclude_patterns = ["README.md", "Pipfile", "Pipfile.lock", "Makefile", "make.bat", "logo.gif", "conf.py",".venv"]
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -117,12 +116,11 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "github_url": "https://github.com/errbufferoverfl/",
-    "twitter_url": "https://twitter.com/errbufferoverfl",
+    "github_url": "https://github.com/sfadriaan/",
+    "twitter_url": "https://twitter.com/sfadriaan",
     "search_bar_text": "Search...",
     "show_prev_next": False,
-    "navbar_center": [],
-    "footer_items": ["copyright", "sphinx-version", "last-updated"],
+    "navbar_center": []
 }
 
 # HTML Sidebar configuration -- options available depend on ablog & the Sphinx theme you use.
@@ -137,9 +135,9 @@
 
 html_sidebars = {
     "*": ["search-field.html", "sidebar-nav.html"],
-    "posts": ["search-field.html", "sidebar-nav.html", "recentposts.html", "archives.html"],
-    "posts/**": ["search-field.html", "sidebar-nav.html", "postcard.html"],
-    "kitchen-sink/**": ["search-field.html", "sidebar-nav.html", "postcard.html"],
+    "posts": ["search-field.html", "sidebar-nav.html", "ablog/recentposts.html", "ablog/archives.html"],
+    "posts/**": ["search-field.html", "sidebar-nav.html", "ablog/postcard.html"],
+    "kitchen-sink/**": ["search-field.html", "sidebar-nav.html", "ablog/postcard.html"],
 }
 
 # The name of an image file (within the static path) to use as favicon of the
@@ -187,8 +185,8 @@
 html_show_sourcelink = True
 
 # -- Opengraph configuration ---------------------------------------------------
-ogp_site_url = "https://errbufferoverfl.github.io/"
-ogp_image = "https://errbufferoverfl.github.io/_static/opengraph.png"
+ogp_site_url = "https://sfadriaan.github.io/"
+ogp_image = "https://sfadriaan.github.io/_static/opengraph.png"
 ogp_use_first_image = True
 ogp_image_alt = ""
 ogp_description_length = 200