Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UX: Disable version chooser, this project is not versioned #78

Merged
merged 7 commits into from
Sep 13, 2023
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
14 changes: 11 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ on:
branches:
- main

# Skip running redundant builds.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
documentation:
name: Build docs on ${{ matrix.os }}
Expand All @@ -15,11 +20,14 @@ jobs:
os: [ubuntu-latest, macos-latest]

steps:
- uses: actions/checkout@v2
- name: Acquire sources
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.7
python-version: '3.11'

- name: Build docs
run: |
cd docs && make check
1 change: 0 additions & 1 deletion .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ pull_request_rules:
queue:
method: rebase
name: default
rebase_fallback: none
6 changes: 5 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.11"

sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true

python:
version: 3.7
install:
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion DEVELOP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The project is written using `Sphinx`_ and `ReStructuredText`_.
Working on the project
======================

Python 3.7 is required.
You will need a recent installation of Python 3.

Change into the ``docs`` directory:

Expand Down
2 changes: 1 addition & 1 deletion docs/build.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"schemaVersion": 1,
"label": "docs build",
"message": "2.0.1"
"message": "2.1.1"
}
7 changes: 7 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
from crate.theme.rtd.conf.sql_99 import *

# Disable version chooser.
html_context.update({
"display_version": False,
"current_version": None,
"versions": [],
})