Skip to main content

Adding LaTeX support to Inline!

Project description

hexdoc-inlinelatex

Python web book docgen and hexdoc plugin for Inline: LaTeX.

Adding LaTeX support to Inline!

Version scheme

We use hatch-gradle-version to generate the version number based on whichever mod version the docgen was built with.

The version is in this format: mod-version.python-version.mod-pre.python-dev.python-post

For example:

  • Mod version: 0.11.1-7
  • Python package version: 1.0.dev0
  • Full version: 0.11.1.1.0rc7.dev0

Setup

Install uv, then:

uv sync

.\.venv\Scripts\activate   # Windows
. .venv/bin/activate.fish  # fish
source .venv/bin/activate  # everything else

Usage

For local testing, create a file called .env in the repo root following this template:

GITHUB_REPOSITORY=TechTastic/Inline-LaTeX
GITHUB_SHA=main
GITHUB_PAGES_URL=https://techtastic.github.io/Inline-LaTeX

Useful commands:

# update your Python environment and lockfile if you added new dependencies
uv sync

# show help
hexdoc -h

# render and serve the web book in watch mode
nodemon --config doc/nodemon.json

# render and serve the web book
hexdoc serve

# build and merge the web book
hexdoc build
hexdoc merge

# start the Python interpreter with some extra local variables
hexdoc repl

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hexdoc_inline_latex-1.0.0.1.7.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hexdoc_inline_latex-1.0.0.1.7-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file hexdoc_inline_latex-1.0.0.1.7.tar.gz.

File metadata

  • Download URL: hexdoc_inline_latex-1.0.0.1.7.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hexdoc_inline_latex-1.0.0.1.7.tar.gz
Algorithm Hash digest
SHA256 745f35cf5cdbdb7dc28250f66a70e31febf04fbee71d00e9407f8add8b55920a
MD5 4a864fd0b31bae08213fbdf4a99bb4ee
BLAKE2b-256 4586042a1d27089ffb23f1df2a2d53e931bbc59302350e82fa58d3476ff2c394

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_inline_latex-1.0.0.1.7.tar.gz:

Publisher: build_docs.yml on TechTastic/Inline-LaTeX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hexdoc_inline_latex-1.0.0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for hexdoc_inline_latex-1.0.0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 55fb68473e86e8cd45531ccc75c4e1bc8fd941db4a8eae13a79f2efcd5d82c55
MD5 5239eab2fd356f7254f16b007f912a9c
BLAKE2b-256 c83c33cf070fd69328b620ce9ec28187865022c4bc15b52ff455cd9f5a1a06bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for hexdoc_inline_latex-1.0.0.1.7-py3-none-any.whl:

Publisher: build_docs.yml on TechTastic/Inline-LaTeX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page