[Change] docs format

CHANGELOG.rst

@@ -2,6 +2,10 @@
 Changelog
 =========
 
+Version 0.1.3 [2024-02-10]
+--------------------------
+- Changed theme of HTML documentation and added example markdown files to the README.
+
 Version 0.1.2 [2024-02-10]
 --------------------------
 - Added more documentation on how to use the package.

README.rst

@@ -43,6 +43,12 @@ This is a small package I created to help me format references in my documentati
 It uses pandoc to convert the references from bibtex to a format that can be used
 in markdown files.
 
+For example, this `input file`_ along with the corresponding `bibliography file`_ can be used to generate this `output file`_.
+
+.. _input file: https://github.com/danibene/docite/blob/main/src/docite/assets/example_inputfile.md
+.. _bibliography file: https://github.com/danibene/docite/blob/main/src/docite/assets/example_bibfile.bib
+.. _output file: https://github.com/danibene/docite/blob/main/src/docite/assets/example_outputfile.md
+
 Installation
 ================
 You can install the package via pip::
@@ -73,7 +79,7 @@ My personal workflow is:
 
 Here is a gif showing how I use the package:
 
-.. image:: https://github.com/danibene/docite/blob/assets/usage_2024-02-10.gif
+.. image:: https://raw.githubusercontent.com/danibene/docite/assets/usage_2024-02-10.gif
     :alt: Usage
     :align: center
 

docs/_static/custom.css

@@ -0,0 +1,27 @@
+body, .body {
+    background-color: #333333 !important; /* Dark grey background */
+    color: black !important; /* Black text */
+}
+
+a {
+    color: #009688 !important; /* Teal links */
+}
+
+a:visited {
+    color: #00796b !important; /* Darker teal for visited links */
+}
+
+h1, h2, h3, h4, h5, h6 {
+    color: #333333 !important; /* Dark grey for headers */
+}
+
+body {
+    --themecolor: black;
+  }
+
+  .wy-side-nav-search {
+    background-color: var(--themecolor);
+  }
+  .wy-nav-top {
+    background-color: var(--themecolor);
+  }

docs/conf.py

@@ -153,12 +153,11 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {"sidebar_width": "300px", "page_width": "1200px"}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -183,6 +182,9 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+html_css_files = [
+    "custom.css",
+]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/requirements.txt

@@ -2,4 +2,4 @@
 # To build the module reference correctly, make sure every external package
 # under `install_requires` in `setup.cfg` is also listed here!
 sphinx>=3.2.1
-# sphinx_rtd_theme
+sphinx_rtd_theme