Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d875f6c
Initial tooling.
kattni Oct 10, 2025
12e9076
Initial conversion.
kattni Oct 15, 2025
d7ba78b
Convert notes.
kattni Oct 15, 2025
dd558f4
Convert autodocs.
kattni Oct 15, 2025
c1999a8
Manual docs and tabbed content conversion.
kattni Oct 15, 2025
bcb4822
Remove stray closing colons, convert .. class:: directives.
kattni Oct 15, 2025
675b26e
Fix whitespace in fenced code languages.
kattni Oct 15, 2025
6dcab6f
Enable mkdocstrings, replace ::: with <:> to enable successful build.
kattni Oct 15, 2025
1fb0a85
Build state restored.
kattni Oct 15, 2025
98949e4
Update RTD.
kattni Oct 15, 2025
a2b05bf
Add change note.
kattni Oct 15, 2025
0c81407
Remove rST change notes.
kattni Oct 15, 2025
1932f47
Update change note template.
kattni Oct 15, 2025
59aa246
autorefs links, moving docs to source code.
kattni Oct 20, 2025
72f8745
API page updated.
kattni Oct 21, 2025
6ca4146
Updates.
kattni Oct 21, 2025
0ce8d2c
autorefs links updated in docs and src.
kattni Oct 21, 2025
9763330
autorefs missed.
kattni Oct 21, 2025
8d5b77e
Convert inline rST code to Markdown in src.
kattni Oct 21, 2025
2fe2ce6
Apply suggestions from code review
kattni Oct 22, 2025
8361880
Update docstring rST links to Markdown.
kattni Oct 22, 2025
ebcc01c
stubs content successfully rendering with griffe update.
kattni Oct 22, 2025
3d08722
eventloop and runtime documented.
kattni Oct 23, 2025
3cfc524
Main module page done.
kattni Oct 23, 2025
3ecca4a
Working through types.
kattni Oct 23, 2025
165ad4f
Reference done, SUMMARY added.
kattni Oct 23, 2025
1a0e2ab
Remove mocked modules.
kattni Oct 23, 2025
174f667
Updates, fix build.
kattni Oct 24, 2025
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
57 changes: 57 additions & 0 deletions .pyspelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
matrix:
- name: markdown
dictionary:
wordlists:
- docs/spelling_wordlist
output: _build/dictionary/python.dic
sources:
- 'docs/**/*.md'
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.toc
- markdown.extensions.admonition
- markdown.extensions.attr_list
- pymdownx.superfences
- pymdownx.blocks.admonition
- pymdownx.blocks.caption
- pymdownx.blocks.tab
- pymdownx.snippets
- pyspelling.filters.html:
comments: true
attributes:
- title
- alt
ignores:
- 'code'
- 'pre'
- 'figure' # Can be removed once all <figure>s are replaced with Markdown
- 'nospell' # Allows for ignoring a word or words inline.
- pyspelling.filters.context:
context_visible_first: true
escapes: '\\[\\`~]'
delimiters:
# Ignores the Jinja directives and their contents
- open: '{%'
content: '[\d\D]*'
close: '%}'
# Ignores the Jinja directives and their contents
- open: '{{'
content: '[\d\D]*'
close: '}}'
# Ignore the mkdocstrings syntax and its content
- open: '\['
content: '[\d\D]*\]\[[\d\D]*'
close: '\]'
# Ignore the mkdocstrings syntax and its content
- open: ':::'
content: '[\d\D]*'
close: '\n'
# Ignore the single line Snippets syntax
- open: '-8<\-'
content: '[\d\D]*'
close: '\n'
# Ignore the multiline Snippets syntax
- open: '-8<\-\n'
content: '[\d\D]*'
close: '-8<-\n'
39 changes: 11 additions & 28 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,18 @@ version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
os: ubuntu-24.04
tools:
# Docs are always built on Python 3.12. See also the tox config and contribution docs.
# Docs are always built on Python 3.12. See also the tox config.
python: "3.12"
jobs:
post_checkout:
- git fetch --unshallow
pre_install:
- python -m pip install --upgrade pip
- python -m pip install --group 'tox-uv'
pre_build:
- tox -e docs-lint

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true

# Optionally build your docs in additional formats such as PDF
formats:
- epub
- pdf

# Set the version of Python and requirements required to build the docs
python:
install:
# Docs requirements are *mostly* handled by the `docs` extra; but we can't include
# the theme that way, so the theme is installed using a requirements.txt file,
# independent of the docs extra. Ideally, we'd use dependency groups for docs
# dependencies, but RTD doesn't support them yet.
- requirements: requirements-docs.txt
- method: pip
path: .
extra_requirements:
- docs
- dev
- python -m tox -e docs-lint
build:
html:
- python -m tox -e docs-$READTHEDOCS_LANGUAGE -- --output=$READTHEDOCS_OUTPUT/html/
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Changelog

A complete history of the changes to Rubicon can be found in [Rubicon's
documentation](./docs/background/releases).
File renamed without changes.
2 changes: 2 additions & 0 deletions changes/629.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `pre-commit-hooks` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/629.misc.rst

This file was deleted.

2 changes: 2 additions & 0 deletions changes/630.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/630.misc.rst

This file was deleted.

File renamed without changes.
2 changes: 2 additions & 0 deletions changes/633.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/633.misc.rst

This file was deleted.

File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions changes/636.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/636.misc.rst

This file was deleted.

File renamed without changes.
File renamed without changes.
3 changes: 2 additions & 1 deletion changes/639.misc.rst → changes/639.misc.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
The pinned dependencies in pyproject.toml and tox.ini were updated to their latest versions.
The pinned dependencies in pyproject.toml and tox.ini were updated to
their latest versions.
2 changes: 2 additions & 0 deletions changes/640.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/640.misc.rst

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions changes/645.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/645.misc.rst

This file was deleted.

File renamed without changes.
2 changes: 2 additions & 0 deletions changes/647.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/647.misc.rst

This file was deleted.

2 changes: 2 additions & 0 deletions changes/649.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/649.misc.rst

This file was deleted.

File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions changes/652.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/652.misc.rst

This file was deleted.

File renamed without changes.
2 changes: 2 additions & 0 deletions changes/655.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The `pre-commit` hook for `ruff-pre-commit` was updated to its latest
version.
1 change: 0 additions & 1 deletion changes/655.misc.rst

This file was deleted.

1 change: 1 addition & 0 deletions changes/658.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Rubicon Obj-C's documentation was migrated to Markdown format.
9 changes: 4 additions & 5 deletions changes/template.rst → changes/template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
{% for section, _ in sections.items() %}
{% set underline = underlines[0] %}{% if section %}{{section}}
{{ underline * section|length }}{% set underline = underlines[1] %}
{% if section %}
{{section}}

{% endif %}

{% if sections[section] %}
{% for category, val in definitions.items() if category in sections[section]%}
{{ definitions[category]['name'] }}
{{ underline * definitions[category]['name']|length }}
### {{ definitions[category]['name'] }}

{% if definitions[category]['showcontent'] %}
{% for text, values in sections[section][category].items() %}
* {{ text }} ({{ values|join(', ') }})
* {{ text }} ({{values|join(', ') }})
{% endfor %}

{% else %}
Expand Down
23 changes: 0 additions & 23 deletions docs/Makefile

This file was deleted.

Loading