Ruby Hammerhead

A template repository for setting up your own Sphinx/ablog website using the Pydata Sphinx Theme.
Explore the docs »

View Demo · Report Bug · Request Feature

• About the Project
  • Built With
• Getting Started
  • Making Changes
• Acknowledgements

About the Project

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
• reStructuredText Primer
• ablog Documentation
• Pydata Documentation
• Sphinx Design Documentation

Getting Started

The first thing you'll need to do is clone this repository locally using Git:

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 an extendable version manager with support for Python, Ruby, Node.js, Elixir, Erlang & more.

pipenv install

Run the default build, which will create a website that looks exactly like the demo site.

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:

/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

While developing your blog & making changes, I recommend running ablog clean before building and serving to make sure you don't accidentally capture artifacts.

ablog clean && ablog build && ablog serve

You can also run ablog clean -D which does a deep clean, removing cached environment and doctree files.

ablog clean -D && ablog build && ablog serve

Acknowledgements

• Chris Holdgraf