sphinx config, theme, etc
Jeff Moe
parent
a858228713
commit
4b8ed44bf5
|
|
@ -0,0 +1,93 @@
|
|||
|
||||
# Makefile
|
||||
# Jeff Moe with Parrot and Phind-CodeLlama-34B-v2_q8.gguf
|
||||
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = docs/_source
|
||||
BUILDDIR = docs/_build
|
||||
AUTOBUILDOPTS = --host 127.0.0.1 --port 8000 --ignore "*.swp" --ignore "*.swx"
|
||||
GETTEXT_BUILD = gettext_build
|
||||
UPDATE_LOCALE = sphinx-intl update -p $(BUILDDIR)/locale/gettext -d $(SOURCEDIR)/locale -l
|
||||
PO_FILES = $(wildcard docs/_source/locale/*/LC_MESSAGES/*.po)
|
||||
MSGATTRIB = msgattrib
|
||||
#LANGUAGES = am ar bg bn ca cak cs cy da de el en eo es et eu fa fi fil fr he hi hr hu id it ja ko lkt lt lv mk mr ms ne nl no pl pt ro ru si sk sl sq sr sv ta te th tr uk ur vi zh
|
||||
LANGUAGES = en
|
||||
|
||||
.PHONY: check help html livehtml clean_sphinx clean gettext_build update_locale build_html all copy clean_po latex latexpdf
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " clean Remove all build files and directories (including translations)"
|
||||
@echo " all Clean and make all targets"
|
||||
@echo " gettext_build Build localisation strings for translation"
|
||||
@echo " update_locale Update localisation"
|
||||
@echo " update_locale_<lang> Update localisation for <lang>"
|
||||
@echo " html Build the HTML documentation for all languages"
|
||||
@echo " html_<lang> Build HTML documentation for <lang>"
|
||||
@echo " latex Build the documentation using LaTeX for all languages"
|
||||
@echo " latex_<lang> Build the documentation using LaTeX for <lang>"
|
||||
@echo " latexpdf Build the PDFS documentation using LaTeX for all languages"
|
||||
@echo " latexpdf_<lang> Build the PDFS documentation using LaTeX for <lang>"
|
||||
@echo " index Copy static docs/index.html to docs/_build/html/index.html"
|
||||
|
||||
all: clean gettext_build update_locale html index
|
||||
|
||||
check:
|
||||
@for po in $(PO_FILES); do \
|
||||
echo "Checking $$po..."; \
|
||||
msgfmt --check --output-file=- "$$po" || exit 1; \
|
||||
done
|
||||
|
||||
index:
|
||||
cp -p docs/index.html docs/_build/html/index.html
|
||||
|
||||
clean:
|
||||
for file in $(PO_FILES); do \
|
||||
$(MSGATTRIB) --no-obsolete -o $$file $$file; \
|
||||
done
|
||||
cd docs && make clean
|
||||
find $(SOURCEDIR) -type f -name "*.mo" -delete
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
gettext_build:
|
||||
$(SPHINXBUILD) -b gettext -c $(SOURCEDIR) -d $(BUILDDIR)/doctrees/$(GETTEXT_BUILD) $(SOURCEDIR) $(BUILDDIR)/locale/gettext
|
||||
|
||||
update_locale:
|
||||
@pids="" ; \
|
||||
for lang in $(LANGUAGES); do \
|
||||
( echo "Updating locale for $$lang..." ; $(UPDATE_LOCALE) $$lang ) & pids="$$pids $$!" ; \
|
||||
done ; \
|
||||
for pid in $$pids; do \
|
||||
wait $$pid ; \
|
||||
done
|
||||
|
||||
update_locale_%:
|
||||
$(UPDATE_LOCALE) $*
|
||||
|
||||
html:
|
||||
@for lang in $(LANGUAGES); do \
|
||||
echo "Building HTML documentation for $$lang..."; \
|
||||
$(SPHINXBUILD) -b html -d $(BUILDDIR)/doctrees -D language=$$lang $(SOURCEDIR) $(BUILDDIR)/html/$$lang; \
|
||||
done
|
||||
|
||||
html_%: gettext_build
|
||||
$(SPHINXBUILD) -b html -d $(BUILDDIR)/doctrees -D language=$* -c $(SOURCEDIR) $(SOURCEDIR) $(BUILDDIR)/html/$*/
|
||||
|
||||
latex:
|
||||
@for lang in $(LANGUAGES); do \
|
||||
echo "Building LaTeX documentation for $$lang..."; \
|
||||
$(SPHINXBUILD) -b latex -d $(BUILDDIR)/doctrees -D language=$$lang -Dlatex_engine=xelatex $(SOURCEDIR) $(BUILDDIR)/latex/$$lang; \
|
||||
done
|
||||
|
||||
latex_%:
|
||||
$(SPHINXBUILD) -b latex -d $(BUILDDIR)/doctrees -D language=$* -Dlatex_engine=xelatex $(SOURCEDIR) $(BUILDDIR)/latex/$*/; \
|
||||
|
||||
latexpdf:
|
||||
@for lang in $(filter-out ar he ja,$(LANGUAGES)); do \
|
||||
echo "Building PDF documentation for $$lang..."; \
|
||||
$(MAKE) -C $(BUILDDIR)/latex/$$lang ; \
|
||||
done
|
||||
|
||||
latexpdf_%:
|
||||
$(MAKE) -C $(BUILDDIR)/latex/$* ; \
|
||||
|
|
@ -1,20 +1,12 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
SOURCEDIR = _source
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
/* Jeff Moe with Parrot and Phind-CodeLlama-34B-v2_q8.gguf */
|
||||
div.footer-wrapper {
|
||||
display: none;
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
|
|
@ -0,0 +1,71 @@
|
|||
import sys, os
|
||||
import sphinx.util.logging
|
||||
|
||||
logger = sphinx.util.logging.getLogger(__name__)
|
||||
|
||||
project = "tinyrocs"
|
||||
copyright = "2023, Jeff Moe"
|
||||
author = "Jeff Moe"
|
||||
version = "0"
|
||||
release = "0.0.1"
|
||||
extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.viewcode",
|
||||
"notfound.extension",
|
||||
"sphinx.ext.intersphinx",
|
||||
"sphinx.ext.napoleon",
|
||||
]
|
||||
templates_path = ["_templates"]
|
||||
exclude_patterns = []
|
||||
source_suffix = ".rst"
|
||||
master_doc = "index"
|
||||
pygments_style = "staroffice"
|
||||
python_display_short_literal_types = True
|
||||
todo_include_todos = False
|
||||
html_show_copyright = False
|
||||
html_static_path = ["_static"]
|
||||
html_favicon = '_static/favicon.ico'
|
||||
html_logo = '_static/logo.png'
|
||||
html_last_updated_fmt: None
|
||||
html_show_sphinx = False
|
||||
html_show_sourcelink = False
|
||||
html_link_suffix = ".html"
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_options = {
|
||||
"style_nav_header_background": "#4fb31f",
|
||||
"display_version": False,
|
||||
"prev_next_buttons_location": "bottom",
|
||||
"collapse_navigation": True,
|
||||
"sticky_navigation": True,
|
||||
"navigation_depth": 4,
|
||||
"includehidden": True,
|
||||
"titles_only": False,
|
||||
}
|
||||
|
||||
html_css_files = [
|
||||
"custom.css",
|
||||
]
|
||||
html_context = {
|
||||
"display_lower_left": True,
|
||||
}
|
||||
|
||||
locale_dirs = ["locale/"]
|
||||
gettext_compact = False
|
||||
language = "en"
|
||||
# languages = ('am', 'ar', 'bn', 'de', 'el', 'en', 'eo', 'es', 'eu', 'fil', 'fr', 'he', 'hi', 'id', 'it', 'ja', 'ko', 'mr', 'ms', 'nl', 'pl', 'pt', 'ru', 'see', 'ta', 'te', 'th', 'tr', 'ur', 'vi', 'zh')
|
||||
languages = "en"
|
||||
html_search_language = "en"
|
||||
|
||||
latex_engine = "xelatex"
|
||||
latex_elements = {
|
||||
"extraclassoptions": "openany,oneside",
|
||||
"sphinxsetup": "hmargin={1in,1in}, vmargin={1in,1in}",
|
||||
"inputenc": "",
|
||||
"utf8extra": "",
|
||||
"preamble": r"""
|
||||
\usepackage{xcolor}
|
||||
\usepackage{polyglossia}
|
||||
""",
|
||||
}
|
||||
|
||||
notfound_urls_prefix = "/en/"
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2023, Jeff Moe
|
||||
# This file is distributed under the same license as the tinyrocs package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: tinyrocs 0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2023-12-30 11:31-0700\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language: en\n"
|
||||
"Language-Team: en <LL@li.org>\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=utf-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.14.0\n"
|
||||
|
||||
#: ../../../_source/index.rst:9
|
||||
msgid "Contents:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../_source/index.rst:7
|
||||
msgid "Welcome to tinyrocs's documentation!"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../_source/index.rst:16
|
||||
msgid "Indices and tables"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../_source/index.rst:18
|
||||
msgid ":ref:`genindex`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../_source/index.rst:19
|
||||
msgid ":ref:`modindex`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../_source/index.rst:20
|
||||
msgid ":ref:`search`"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<!-- Jeff Moe with Parrot and Phind-CodeLlama-34B-v2_q8.gguf -->
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>tinyrocs</title>
|
||||
<noscript>
|
||||
<meta http-equiv="refresh" content="1; url=/en/" />
|
||||
</noscript>
|
||||
<script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
var language = navigator.language || navigator.userLanguage;
|
||||
var path = '/en/';
|
||||
|
||||
switch (language.substr(0, 2)) {
|
||||
case 'en':
|
||||
path = '/en/';
|
||||
break;
|
||||
}
|
||||
|
||||
window.location.href = path;
|
||||
});
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
|
|
@ -1,28 +0,0 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# For the full list of built-in configuration values, see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'tinyrocs'
|
||||
copyright = '2023, Jeff Moe'
|
||||
author = 'Jeff Moe'
|
||||
release = '0.0.1'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = []
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = 'alabaster'
|
||||
html_static_path = ['_static']
|
||||
|
|
@ -33,4 +33,4 @@ if [ -z "${URL}" ]; then
|
|||
exit 1
|
||||
fi
|
||||
|
||||
push_files "./docs/build/html/"
|
||||
push_files "./docs/_build/html/"
|
||||
|
|
|
|||
|
|
@ -17,4 +17,4 @@ function push_files() {
|
|||
"${URL}"
|
||||
}
|
||||
|
||||
push_files "./docs/build/html/"
|
||||
push_files "./docs/_build/html/"
|
||||
|
|
|
|||
Loading…
Reference in New Issue