Skip to content

Commit

Permalink
Convert images in documentation to static URLs
Browse files Browse the repository at this point in the history
Signed-off-by: Brian Warner <[email protected]>
  • Loading branch information
brianwarner authored Nov 24, 2024
1 parent 02419b0 commit a450d5d
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 22 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,5 @@ build: clean test
python3 -m build

html: build
cp -r img docsrc/
sphinx-build -b html docsrc docs -E -d "docsrc/_doctrees"
touch docs/.nojekyll
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

---

![Sample output in HTML format](./img/indifferent.jpg)
![Sample output in HTML format](https://raw.githubusercontent.com/brianwarner/indifferent/main/img/indifferent.jpg)

---

Expand Down Expand Up @@ -260,7 +260,7 @@ compare(

returns:

![Table rendered by Rich](./img/table.jpg)
![Table rendered by Rich](https://raw.githubusercontent.com/brianwarner/indifferent/main/img/table.jpg)

#### Unrendered table

Expand Down Expand Up @@ -548,7 +548,7 @@ returns a file called `page.html` that looks like this:

---

![Formatted indifferent page](./img/page.jpg)
![Formatted indifferent page](https://raw.githubusercontent.com/brianwarner/indifferent/main/img/page.jpg)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 3de047242dee3f7225fa81b5ed3b5ff6
config: 28ef301a7a968a7f30404fa559145ae3
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/.buildinfo.bak
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2ddf295e9ff3c04692b266247e10e999
config: 5f344ed3d9f25b7493b822771d046c51
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; indifferent 0.0.post1.dev1+g2549980 documentation</title>
<title>Overview: module code &mdash; indifferent 0.0.post1.dev1+g049e3b8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=835259e7"></script>
<script src="../_static/documentation_options.js?v=40e7f918"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/indifferent.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>indifferent &mdash; indifferent 0.0.post1.dev1+g2549980 documentation</title>
<title>indifferent &mdash; indifferent 0.0.post1.dev1+g049e3b8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=835259e7"></script>
<script src="../_static/documentation_options.js?v=40e7f918"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.0.post1.dev1+g2549980',
VERSION: '0.0.post1.dev1+g049e3b8',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; indifferent 0.0.post1.dev1+g2549980 documentation</title>
<title>Index &mdash; indifferent 0.0.post1.dev1+g049e3b8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=835259e7"></script>
<script src="_static/documentation_options.js?v=40e7f918"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>indifferent documentation &mdash; indifferent 0.0.post1.dev1+g2549980 documentation</title>
<title>indifferent documentation &mdash; indifferent 0.0.post1.dev1+g049e3b8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=835259e7"></script>
<script src="_static/documentation_options.js?v=40e7f918"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down Expand Up @@ -112,7 +112,7 @@ <h1>indifferent documentation<a class="headerlink" href="#indifferent-documentat
<h2>Indifferent<a class="headerlink" href="#indifferent" title="Link to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">indifferent</span></code> analyzes two strings, computes the difference between the two, and prints the results in a variety of formats. It is indifferent to formatting and separators, focusing on the actual content of the strings.</p>
<hr class="docutils" />
<p><img alt="Sample output in HTML format" src="_images/indifferent.jpg" /></p>
<p><img alt="Sample output in HTML format" src="https://raw.githubusercontent.com/brianwarner/indifferent/main/img/indifferent.jpg" /></p>
<hr class="docutils" />
<p>It can produce results in a variety of forms, from raw unprocessed results to formatted HTML.</p>
<section id="how-it-works">
Expand Down Expand Up @@ -347,7 +347,7 @@ <h5>Table for terminal output<a class="headerlink" href="#table-for-terminal-out
</pre></div>
</div>
<p>returns:</p>
<p><img alt="Table rendered by Rich" src="_images/table.jpg" /></p>
<p><img alt="Table rendered by Rich" src="https://raw.githubusercontent.com/brianwarner/indifferent/main/img/table.jpg" /></p>
</section>
<section id="unrendered-table">
<h5>Unrendered table<a class="headerlink" href="#unrendered-table" title="Link to this heading"></a></h5>
Expand Down Expand Up @@ -616,7 +616,7 @@ <h5>Styled HTML page<a class="headerlink" href="#styled-html-page" title="Link t
</div>
<p>returns a file called <code class="docutils literal notranslate"><span class="pre">page.html</span></code> that looks like this:</p>
<hr class="docutils" />
<p><img alt="Formatted indifferent page" src="_images/page.jpg" /></p>
<p><img alt="Formatted indifferent page" src="https://raw.githubusercontent.com/brianwarner/indifferent/main/img/page.jpg" /></p>
</section>
</section>
</section>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &mdash; indifferent 0.0.post1.dev1+g2549980 documentation</title>
<title>Python Module Index &mdash; indifferent 0.0.post1.dev1+g049e3b8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=835259e7"></script>
<script src="_static/documentation_options.js?v=40e7f918"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; indifferent 0.0.post1.dev1+g2549980 documentation</title>
<title>Search &mdash; indifferent 0.0.post1.dev1+g049e3b8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />



<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=835259e7"></script>
<script src="_static/documentation_options.js?v=40e7f918"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
Binary file removed img/indifferent.jpg
Binary file not shown.
Binary file removed img/page.jpg
Binary file not shown.
Binary file removed img/table.jpg
Binary file not shown.

0 comments on commit a450d5d

Please sign in to comment.