docs.libre.is initial site layout

Makefile

@@ -0,0 +1,96 @@
+# Makefile
+
+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"
+	@echo "  translations	 Translate from English. Note: needs AI translator set up"
+
+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/$* ; \
+
+translations:
+	./scripts/translate-all.sh
+

docs/Makefile

@@ -0,0 +1,12 @@
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = _source
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_source/_static/custom.css

@@ -0,0 +1,6 @@
+div.footer-wrapper {
+    display: none;
+}
+.wy-nav-content {
+   max-width: 95%;
+}

docs/_source/_templates/latex.tex

@@ -0,0 +1,6 @@
+{% extends 'article.tpl' %}
+
+{% block packages %}
+\usepackage{fontspec}
+{{ super() }}
+{% endblock packages %}

docs/_source/_templates/layout.html

@@ -0,0 +1,6 @@
+{% extends "!layout.html" %}
+
+{%- block extrahead %}
+<link rel="stylesheet" type="text/css" href="{{ pathto('_static/handsontable.full.min.css', 1) }}">
+<script src="{{ pathto('_static/handsontable.full.min.js', 1) }}"></script>
+{% endblock %}

docs/_source/about.rst

@@ -0,0 +1,31 @@
+=====
+About
+=====
+This is documentation for the users of libre.is.
+
+
+Status
+======
+Under development.
+
+
+Issues
+======
+Issues are tracked with Forgejo:
+
+* https://code.libre.is/libre/docs-libre-is/issues
+
+
+Links
+=====
+
+  `<https://docs.libre.is/>`_
+
+  `<https://code.libre.is/libre/docs-libre-is>`_
+
+
+Author
+======
+| Libre Documentation Developers <docs-libre-is@libre.is>
+| New Hampshire, USA
+

docs/_source/conf.py

@@ -0,0 +1,74 @@
+import sys, os
+import sphinx.util.logging
+
+#sys.path.append("../../src/docs-libre-is")
+
+logger = sphinx.util.logging.getLogger(__name__)
+
+project = "docs-libre-is: very project"
+copyright = "2024, Muh Author Name"
+author = "Muh Author Name"
+version = "0"
+release = "0.4.3"
+extensions = [
+    "notfound.extension",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+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/"
+

docs/_source/index.rst

@@ -0,0 +1,14 @@
+========================
+Libre User Documentation
+========================
+
+Libre users documentation.
+
+* All the things
+
+
+.. toctree::
+   about
+   license
+   :maxdepth: 2
+   :caption: Contents:

docs/_source/license.rst

@@ -0,0 +1,7 @@
+=======
+License
+=======
+Libre Users Documentation files are released under the Apache 2.0 license.
+
+Copyright (C) 2024, Jeff Moe
+

docs/_source/locale/en/LC_MESSAGES/about.po

@@ -0,0 +1,73 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2024, Muh Author Name
+# This file is distributed under the same license as the docs-libre-is: very
+# project package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: docs-libre-is: very project 0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-09-02 06:32-0600\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.16.0\n"
+
+#: ../../../_source/about.rst:3
+msgid "About"
+msgstr ""
+
+#: ../../../_source/about.rst:4
+msgid "This is documentation for the users of libre.is."
+msgstr ""
+
+#: ../../../_source/about.rst:8
+msgid "Status"
+msgstr ""
+
+#: ../../../_source/about.rst:9
+msgid "Under development."
+msgstr ""
+
+#: ../../../_source/about.rst:13
+msgid "Issues"
+msgstr ""
+
+#: ../../../_source/about.rst:14
+msgid "Issues are tracked with Forgejo:"
+msgstr ""
+
+#: ../../../_source/about.rst:16
+msgid "https://code.libre.is/libre/docs-libre-is/issues"
+msgstr ""
+
+#: ../../../_source/about.rst:20
+msgid "Links"
+msgstr ""
+
+#: ../../../_source/about.rst:22
+msgid "`<https://docs.libre.is/>`_"
+msgstr ""
+
+#: ../../../_source/about.rst:24
+msgid "`<https://code.libre.is/libre/docs-libre-is>`_"
+msgstr ""
+
+#: ../../../_source/about.rst:28
+msgid "Author"
+msgstr ""
+
+#: ../../../_source/about.rst:29
+msgid "Libre Documentation Developers <docs-libre-is@libre.is>"
+msgstr ""
+
+#: ../../../_source/about.rst:30
+msgid "New Hampshire, USA"
+msgstr ""

docs/_source/locale/en/LC_MESSAGES/index.po

@@ -0,0 +1,37 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2024, Muh Author Name
+# This file is distributed under the same license as the docs-libre-is: very
+# project package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: docs-libre-is: very project 0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-09-02 06:03-0600\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.16.0\n"
+
+#: ../../../_source/index.rst:10
+msgid "Contents:"
+msgstr ""
+
+#: ../../../_source/index.rst:3
+msgid "Libre User Documentation"
+msgstr ""
+
+#: ../../../_source/index.rst:5
+msgid "Libre users documentation."
+msgstr ""
+
+#: ../../../_source/index.rst:7
+msgid "All the things"
+msgstr ""

docs/_source/locale/en/LC_MESSAGES/license.po

@@ -0,0 +1,34 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2024, Muh Author Name
+# This file is distributed under the same license as the docs-libre-is: very
+# project package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: docs-libre-is: very project 0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-09-02 06:05-0600\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.16.0\n"
+
+#: ../../../_source/license.rst:3
+msgid "License"
+msgstr ""
+
+#: ../../../_source/license.rst:4
+msgid ""
+"Libre Users Documentation files are released under the Apache 2.0 license."
+msgstr ""
+
+#: ../../../_source/license.rst:6
+msgid "Copyright (C) 2024, Jeff Moe"
+msgstr ""

docs/index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">  
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Libre Developers Documentation.</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>

pyproject.toml

@@ -0,0 +1,91 @@
+# pyproject.toml
+
+[tool.poetry]
+name = "docs-libre-is"
+description = "Libre Users Documentation."
+authors = [
+    "Libre Documentation Developers <docs-libre-is@libre.is>"
+]
+license = "Apache-2.0"
+# https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Topic :: Education",
+]
+
+readme = "README.md"
+version = "0.0.1"
+
+# If a Python code subdirectory is used:
+# packages = [
+#    { include = "foocode" },
+# ]
+package-mode = false
+
+[tool.poetry.dependencies]
+polib = "*"
+pycountry = "*"
+pygments = "*"
+python = ">=3.10"
+requests = "*"
+setuptools_scm = "*"
+sphinx = "*"
+sphinx-autobuild = "*"
+sphinx-autodoc-typehints = "*"
+sphinx-intl = "*"
+sphinx-notfound-page = "*"
+sphinx-rtd-theme = "*"
+sphinxcontrib-markdown = "*"
+
+[build-system]
+requires = ["poetry-core", "setuptools_scm"]
+build-backend = "poetry.core.masonry.api"
+
+# If separate scripts are do be added
+# [tool.poetry.scripts]
+# librescript   = "librescript:main"
+
+
+[tool.poetry.urls]
+homepage = "https://docs.libre.is"
+documentation = "https://docs.libre.is"
+repository = "https://code.libre.is/libre/docs-libre-is"
+issues = "https://code.libre.is/libre/docs-libre-is/issues"
+changelog = "https://code.libre.is/libre/docs-libre-is/raw/branch/main/CHANGELOG.txt"
+
+# Directory of Python scripts, if used.
+# [options.packages.find]
+# include = "libre"
+# [options.package_data]
+# libre = "_version.py"
+
+[tool.poetry.dev-dependencies]
+black = "*"
+poetry = "*"
+pyprof2calltree = "*"
+# Linter
+# ruff = "*"
+# If pushed to pypi
+# twine = "*"
+
+# Auto versioning for scripts
+# [tool.setuptools_scm]
+# write_to = "libre/_version.py"
+
+# If linter is used
+# [tool.ruff]
+# line-length = 88
+# [tool.ruff.lint]
+# select = [
+#    "E",
+#    "W",
+#    "F",
+#]
+# ignore = [ "E501" ]