Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 0 additions & 41 deletions .github/workflows/publish.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .readthedocs.yaml

This file was deleted.

9 changes: 9 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
Version 0.3.6 (2026-04-08)
---------------------------
* Docs: Migrated user-facing documentation to https://openlegalstandard.org/resources/folio-python-library — comprehensive 9-page reference covering install, search, query, taxonomy, properties, serialization, LLM integration, and a complete API surface (alea-institute/folio-python#14)
* Removed: `docs/` directory (Sphinx site that targeted the broken folio-python.readthedocs.io)
* Removed: `.readthedocs.yaml` (RTD config no longer needed)
* Removed: `.github/workflows/publish.yml` (Trusted Publisher workflow that was never configured on PyPI; releases are published locally via `uv build && uvx twine upload`)
* Updated: README documentation link now points at openlegalstandard.org; logo path moved from `docs/_static/folio-logo.png` to `assets/folio-logo.png`
* Updated: CONTRIBUTING.md notes that user-facing docs live in the openlegalstandard.org repo and should be updated alongside any public-API changes

Version 0.3.5 (2026-04-08)
---------------------------
* Added: `case_sensitive` parameter (default `False`) on `search_by_prefix()` — lowercase and mixed-case queries now match labels via a parallel lowercase MARISA trie using `str.casefold()` for Unicode-safe folding
Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ To set up the project for development:
- Test full build via docker (Ubuntu 24.04): `bash docker/build.sh`
- Test clean install via docker (Ubuntu 22.04, Ubuntu 24.04): `bash docker/install.sh`

## Documentation

User-facing documentation lives in the [openlegalstandard.org](https://github.com/alea-institute/openlegalstandard.org) repository under [`src/pages/resources/folio-python-library/`](https://github.com/alea-institute/openlegalstandard.org/tree/main/src/pages/resources/folio-python-library), and is published at **[openlegalstandard.org/resources/folio-python-library](https://openlegalstandard.org/resources/folio-python-library)**.

PRs that change public API (signatures, defaults, behavior) should also update the matching sub-page in that repo so the docs stay in sync. Every code snippet in the docs is validated against the published wheel via `uv run python`, so please run any new examples before submitting.

## Coding Style

We generally follow the [PEP 8](https://pep8.org/) style guide for Python code, but the good news is that most style
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FOLIO Python Library

![FOLIO Logo](docs/_static/folio-logo.png)
![FOLIO Logo](assets/folio-logo.png)

[![PyPI version](https://badge.fury.io/py/folio-python.svg)](https://badge.fury.io/py/folio-python)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Expand Down Expand Up @@ -181,7 +181,11 @@ Avoid `effort: "high"` — benchmarks show 5x latency with no quality improvemen

## Documentation

For more detailed information about using the FOLIO Python library, please refer to our [full documentation](https://folio-python.readthedocs.io/).
The full library reference lives on the FOLIO standards site:

**[openlegalstandard.org/resources/folio-python-library](https://openlegalstandard.org/resources/folio-python-library)**

It covers installation, initialization, fuzzy and prefix search, structured queries, taxonomy traversal, object properties and triples, serialization, LLM integration, and a complete API reference for `FOLIO`, `OWLClass`, `OWLObjectProperty`, and `FOLIOConfiguration`. Every code example is validated against the published wheel.

## Contributing

Expand Down
File renamed without changes
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

Binary file removed docs/_static/favicon-32x32.png
Binary file not shown.
84 changes: 0 additions & 84 deletions docs/conf.py

This file was deleted.

Loading
Loading