mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2026-10-16 19:32:01 -05:00
Compare commits
10
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e276b9ca5d | ||
|
|
271c3a9b70 | ||
|
|
5e734b4424 | ||
|
|
62069146e3 | ||
|
|
d2cd909f6b | ||
|
|
5d10a1f2fb | ||
|
|
966d5e4ba7 | ||
|
|
0aae6ce01a | ||
|
|
8d6ce57c87 | ||
|
|
c8a20f3e08 |
No files matched your search
@@ -1,103 +0,0 @@
|
||||
version: 2.1
|
||||
|
||||
orbs:
|
||||
node: circleci/node@5.0.2
|
||||
|
||||
commands:
|
||||
run-tox:
|
||||
description: "Run tox"
|
||||
parameters:
|
||||
version:
|
||||
type: string
|
||||
sphinx-version:
|
||||
type: string
|
||||
default: "latest"
|
||||
steps:
|
||||
- checkout
|
||||
# We cannot upgrade to Tox4 because running generative environments doesn't work.
|
||||
# I guess it has changed its syntax or similar.
|
||||
# $ tox run -e "py310-sphinx{50,51}"
|
||||
# ROOT: HandledError| provided environments not found in configuration file: ['51}']
|
||||
- run: pip install --user 'tox~=3.27'
|
||||
- run: tox -e "<<parameters.version>>-sphinx{<<parameters.sphinx-version>>}"
|
||||
run-build:
|
||||
description: "Ensure built assets are up to date"
|
||||
steps:
|
||||
- checkout
|
||||
- node/install:
|
||||
node-version: '14.20'
|
||||
- run: npm ci
|
||||
- run: npm run build
|
||||
- run:
|
||||
name: Ensure built assets are up to date
|
||||
command: |
|
||||
if [[ `git status sphinx_rtd_theme/ --porcelain` ]]
|
||||
then
|
||||
echo "ERROR: assets are out of date. Make sure to run 'npm run build' on your branch."
|
||||
git status sphinx_rtd_theme/ --porcelain
|
||||
exit 1
|
||||
fi
|
||||
|
||||
jobs:
|
||||
build:
|
||||
docker:
|
||||
- image: 'cimg/python:3.9-node'
|
||||
steps:
|
||||
- run-build: {}
|
||||
py38:
|
||||
docker:
|
||||
- image: 'cimg/python:3.8'
|
||||
steps:
|
||||
- run-tox:
|
||||
version: py38
|
||||
sphinx-version: "60,61,62,70,71"
|
||||
py39:
|
||||
docker:
|
||||
- image: 'cimg/python:3.9'
|
||||
steps:
|
||||
- run-tox:
|
||||
version: py39
|
||||
sphinx-version: "60,61,62,70,71,72,73,74"
|
||||
py310:
|
||||
docker:
|
||||
- image: 'cimg/python:3.10'
|
||||
steps:
|
||||
- run-tox:
|
||||
version: py310
|
||||
sphinx-version: "60,61,62,70,71,72,73,74,80,latest,dev"
|
||||
py311:
|
||||
docker:
|
||||
- image: 'cimg/python:3.11'
|
||||
steps:
|
||||
- run-tox:
|
||||
version: py311
|
||||
sphinx-version: "72,73,74,80,latest,dev"
|
||||
|
||||
py312:
|
||||
docker:
|
||||
- image: 'cimg/python:3.12'
|
||||
steps:
|
||||
- run-tox:
|
||||
version: py312
|
||||
sphinx-version: "72,73,74,80,latest,dev"
|
||||
|
||||
workflows:
|
||||
version: 2
|
||||
tests:
|
||||
jobs:
|
||||
- build
|
||||
- py312:
|
||||
requires:
|
||||
- build
|
||||
- py311:
|
||||
requires:
|
||||
- build
|
||||
- py310:
|
||||
requires:
|
||||
- build
|
||||
- py39:
|
||||
requires:
|
||||
- build
|
||||
- py38:
|
||||
requires:
|
||||
- build
|
||||
@@ -1 +0,0 @@
|
||||
* @readthedocs/theme
|
||||
@@ -1,11 +1,3 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: 'Bug, Needed: replication'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Problem
|
||||
|
||||
+1
-12
@@ -11,19 +11,8 @@
|
||||
.ruby-version
|
||||
dist/
|
||||
bower_components/
|
||||
include/
|
||||
lib/
|
||||
local/
|
||||
node_modules
|
||||
npm-debug.log
|
||||
pip-selfcheck.json
|
||||
package-lock.json
|
||||
sphinx_rtd_theme/static/fonts/Lato/
|
||||
sphinx_rtd_theme/static/fonts/RobotoSlab/
|
||||
.python-version
|
||||
.node-version
|
||||
.tool-versions
|
||||
.nvmrc
|
||||
.direnv/
|
||||
.envrc
|
||||
# Used for dockerized builds
|
||||
.container_id
|
||||
+3
-13
@@ -1,15 +1,5 @@
|
||||
version: 2
|
||||
|
||||
build:
|
||||
os: "ubuntu-22.04"
|
||||
tools:
|
||||
python: "3.10"
|
||||
|
||||
image: latest
|
||||
python:
|
||||
install:
|
||||
- requirements: docs/requirements.txt
|
||||
- method: pip
|
||||
path: .
|
||||
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
version: 3.6
|
||||
requirements_file: docs/requirements.txt
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
language: python
|
||||
python:
|
||||
- 2.7
|
||||
- 3.4
|
||||
- 3.5
|
||||
- 3.6
|
||||
matrix:
|
||||
include:
|
||||
- python: 2.7
|
||||
env: TOXENV=docs
|
||||
install:
|
||||
- pip install tox-travis
|
||||
script:
|
||||
- tox
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
[sphinx-rtd-theme.sphinx-rtd-theme]
|
||||
file_filter = sphinx_rtd_theme/locale/<lang>/LC_MESSAGES/sphinx.po
|
||||
minimum_perc = 60
|
||||
source_file = sphinx_rtd_theme/locale/en/LC_MESSAGES/sphinx.po
|
||||
source_lang = en
|
||||
|
||||
[main]
|
||||
host = https://www.transifex.com
|
||||
type = PO
|
||||
|
||||
-60
@@ -1,60 +0,0 @@
|
||||
# This implicitly includes Python 3.10
|
||||
FROM node:14-alpine
|
||||
|
||||
# Do not use --update since that will also fetch the
|
||||
# latest node-current package
|
||||
# 'make' is needed for building documentation
|
||||
RUN apk add npm make py3-pip py3-wheel
|
||||
|
||||
# Add an extra verification that we have the right node
|
||||
# because the above caused issues
|
||||
RUN node -v && node -v | grep -q v14 &&\
|
||||
python3 --version && python3 --version | grep -q "3.10"
|
||||
|
||||
RUN pip install pip --upgrade
|
||||
|
||||
RUN mkdir -p /project/src/ &&\
|
||||
mkdir -p /project/docs/build/ &&\
|
||||
mkdir -p /project-minimal-copy/sphinx_rtd_theme &&\
|
||||
touch /project-minimal-copy/sphinx_rtd_theme/__init__.py
|
||||
|
||||
# This is the main working directory where node_modules
|
||||
# gets built. During runtime, it's mixed with directories
|
||||
# from an external environment through a bind mount
|
||||
WORKDIR /project
|
||||
|
||||
# Copy files necessary to run "npm install" and save
|
||||
# installed packages in the docker image (makes the runtime
|
||||
# so much faster)
|
||||
COPY package.json /project/
|
||||
COPY bin/preinstall.js /project/bin/preinstall.js
|
||||
|
||||
RUN cd /project
|
||||
|
||||
# It matters that the node environment is installed into the same
|
||||
# folder, i.e. /project where we will run the environment from
|
||||
# TODO: We don't want to update package-lock.json here, we
|
||||
# should use npm ci instead
|
||||
RUN npm install --package-lock-only &&\
|
||||
npm audit fix &&\
|
||||
npm install
|
||||
|
||||
# This is strictly speaking not necessary, just makes
|
||||
# running the container faster...
|
||||
# Install dependencies, then uninstall project itself
|
||||
COPY setup.py README.rst /project-minimal-copy/
|
||||
RUN cd /project-minimal-copy &&\
|
||||
pip install ".[dev]" &&\
|
||||
/usr/bin/yes | pip uninstall sphinx_rtd_theme
|
||||
|
||||
|
||||
# Copy in files that we need to run the project. These files
|
||||
# will not be mounted into the runtime from external environment
|
||||
# so we copy them during build.
|
||||
COPY webpack.common.js webpack.dev.js webpack.prod.js /project/
|
||||
|
||||
# Copy in the entrypoint and we're done
|
||||
COPY docker-entrypoint.sh /entrypoint.sh
|
||||
RUN chmod +x /entrypoint.sh
|
||||
|
||||
ENTRYPOINT ["/entrypoint.sh"]
|
||||
+189
@@ -0,0 +1,189 @@
|
||||
module.exports = function(grunt) {
|
||||
|
||||
// load all grunt tasks
|
||||
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
|
||||
|
||||
grunt.initConfig({
|
||||
// Read package.json
|
||||
pkg: grunt.file.readJSON("package.json"),
|
||||
|
||||
open : {
|
||||
dev: {
|
||||
path: 'http://localhost:1919'
|
||||
}
|
||||
},
|
||||
|
||||
connect: {
|
||||
server: {
|
||||
options: {
|
||||
port: 1919,
|
||||
base: 'docs/build',
|
||||
livereload: true
|
||||
}
|
||||
}
|
||||
},
|
||||
copy: {
|
||||
fonts: {
|
||||
files: [
|
||||
{
|
||||
expand: true,
|
||||
flatten: true,
|
||||
src: ['bower_components/font-awesome/fonts/*'],
|
||||
dest: 'sphinx_rtd_theme/static/fonts/',
|
||||
filter: 'isFile'
|
||||
},
|
||||
{
|
||||
expand: true,
|
||||
flatten: true,
|
||||
src: ['fonts/Lato/*'],
|
||||
dest: 'sphinx_rtd_theme/static/fonts/Lato',
|
||||
filter: 'isFile'
|
||||
},
|
||||
{
|
||||
expand: true,
|
||||
flatten: true,
|
||||
src: ['fonts/RobotoSlab/*'],
|
||||
dest: 'sphinx_rtd_theme/static/fonts/RobotoSlab/',
|
||||
filter: 'isFile'
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
|
||||
sass: {
|
||||
dev: {
|
||||
options: {
|
||||
style: 'expanded',
|
||||
loadPath: ['bower_components/bourbon/dist', 'bower_components/neat/app/assets/stylesheets', 'bower_components/font-awesome/scss', 'bower_components/wyrm/sass']
|
||||
},
|
||||
files: [{
|
||||
expand: true,
|
||||
cwd: 'sass',
|
||||
src: ['*.sass'],
|
||||
dest: 'sphinx_rtd_theme/static/css',
|
||||
ext: '.css'
|
||||
}]
|
||||
},
|
||||
build: {
|
||||
options: {
|
||||
style: 'compressed',
|
||||
sourcemap: 'none',
|
||||
loadPath: ['bower_components/bourbon/dist', 'bower_components/neat/app/assets/stylesheets', 'bower_components/font-awesome/scss', 'bower_components/wyrm/sass']
|
||||
},
|
||||
files: [{
|
||||
expand: true,
|
||||
cwd: 'sass',
|
||||
src: ['*.sass'],
|
||||
dest: 'sphinx_rtd_theme/static/css',
|
||||
ext: '.css'
|
||||
}]
|
||||
}
|
||||
},
|
||||
|
||||
browserify: {
|
||||
dev: {
|
||||
options: {
|
||||
external: ['jquery'],
|
||||
alias: {
|
||||
'sphinx-rtd-theme': './js/theme.js_t'
|
||||
}
|
||||
},
|
||||
src: ['js/*.js_t'],
|
||||
dest: 'sphinx_rtd_theme/static/js/theme.js_t'
|
||||
},
|
||||
build: {
|
||||
options: {
|
||||
external: ['jquery'],
|
||||
alias: {
|
||||
'sphinx-rtd-theme': './js/theme.js_t'
|
||||
}
|
||||
},
|
||||
src: ['js/*.js_t'],
|
||||
dest: 'sphinx_rtd_theme/static/js/theme.js_t'
|
||||
}
|
||||
},
|
||||
uglify: {
|
||||
dist: {
|
||||
options: {
|
||||
sourceMap: false,
|
||||
mangle: {
|
||||
reserved: ['jQuery'] // Leave 'jQuery' identifier unchanged
|
||||
},
|
||||
ie8: true // compliance with IE 6-8 quirks
|
||||
},
|
||||
files: [{
|
||||
expand: true,
|
||||
src: ['sphinx_rtd_theme/static/js/*.js_t', '!sphinx_rtd_theme/static/js/*.min.js_t'],
|
||||
dest: 'sphinx_rtd_theme/static/js/',
|
||||
rename: function (dst, src) {
|
||||
// Use unminified file name for minified file
|
||||
return src;
|
||||
}
|
||||
}]
|
||||
}
|
||||
},
|
||||
usebanner: {
|
||||
dist: {
|
||||
options: {
|
||||
position: 'top',
|
||||
banner: '/* <%= pkg.name %> version <%= pkg.version %> | MIT license */\n' +
|
||||
'/* Built <%= grunt.template.today("yyyymmdd HH:mm") %> */',
|
||||
linebreak: true
|
||||
},
|
||||
files: {
|
||||
src: [ 'sphinx_rtd_theme/static/js/theme.js_t', 'sphinx_rtd_theme/static/css/theme.css' ]
|
||||
}
|
||||
}
|
||||
},
|
||||
exec: {
|
||||
bower_update: {
|
||||
cmd: 'bower update'
|
||||
},
|
||||
build_sphinx: {
|
||||
cmd: 'sphinx-build docs/ docs/build'
|
||||
}
|
||||
},
|
||||
clean: {
|
||||
build: ["docs/build"],
|
||||
fonts: ["sphinx_rtd_theme/static/fonts"],
|
||||
css: ["sphinx_rtd_theme/static/css"],
|
||||
js: ["sphinx_rtd_theme/static/js/*", "!sphinx_rtd_theme/static/js/modernizr.min.js"]
|
||||
},
|
||||
|
||||
watch: {
|
||||
/* Compile sass changes into theme directory */
|
||||
sass: {
|
||||
files: ['sass/*.sass', 'bower_components/**/*.sass'],
|
||||
tasks: ['sass:dev']
|
||||
},
|
||||
/* Changes in theme dir rebuild sphinx */
|
||||
sphinx: {
|
||||
files: ['sphinx_rtd_theme/**/*', 'README.rst', 'docs/**/*.rst', 'docs/**/*.py'],
|
||||
tasks: ['clean:build','exec:build_sphinx']
|
||||
},
|
||||
/* JavaScript */
|
||||
browserify: {
|
||||
files: ['js/*.js_t','js/*.js'],
|
||||
tasks: ['browserify:dev']
|
||||
},
|
||||
/* live-reload the docs if sphinx re-builds */
|
||||
livereload: {
|
||||
files: ['docs/build/**/*'],
|
||||
options: { livereload: true }
|
||||
}
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
grunt.loadNpmTasks('grunt-exec');
|
||||
grunt.loadNpmTasks('grunt-contrib-connect');
|
||||
grunt.loadNpmTasks('grunt-contrib-watch');
|
||||
grunt.loadNpmTasks('grunt-contrib-sass');
|
||||
grunt.loadNpmTasks('grunt-contrib-clean');
|
||||
grunt.loadNpmTasks('grunt-contrib-copy');
|
||||
grunt.loadNpmTasks('grunt-open');
|
||||
grunt.loadNpmTasks('grunt-browserify');
|
||||
|
||||
grunt.registerTask('default', ['exec:bower_update','clean','copy:fonts','sass:dev','browserify:dev','usebanner','exec:build_sphinx','connect','open','watch']);
|
||||
grunt.registerTask('build', ['exec:bower_update','clean','copy:fonts','sass:build','browserify:build','uglify','usebanner','exec:build_sphinx']);
|
||||
}
|
||||
@@ -1,18 +1,13 @@
|
||||
include *.txt
|
||||
include babel.cfg
|
||||
include LICENSE
|
||||
include bin/preinstall.js
|
||||
recursive-include sphinx_rtd_theme *.conf
|
||||
recursive-include sphinx_rtd_theme *.css
|
||||
recursive-include sphinx_rtd_theme *.eot
|
||||
recursive-include sphinx_rtd_theme *.html
|
||||
recursive-include sphinx_rtd_theme *.js
|
||||
recursive-include sphinx_rtd_theme *.js_t
|
||||
recursive-include sphinx_rtd_theme *.svg
|
||||
recursive-include sphinx_rtd_theme *.ttf
|
||||
recursive-include sphinx_rtd_theme *.woff
|
||||
recursive-include sphinx_rtd_theme *.woff2
|
||||
recursive-include sphinx_rtd_theme/locale *.pot *.po *.mo
|
||||
recursive-include tests *.py
|
||||
recursive-include tests *.rst
|
||||
prune build
|
||||
@@ -1,19 +0,0 @@
|
||||
SHELL := /bin/bash
|
||||
CWD := $(shell cd -P -- '$(shell dirname -- "$0")' && pwd -P)
|
||||
|
||||
docker-images:
|
||||
docker-compose build
|
||||
|
||||
docker-npm-build:
|
||||
rm -f .container_id
|
||||
docker-compose run -d sphinx_rtd_theme build > .container_id
|
||||
sleep 1s
|
||||
docker container wait "$(shell cat .container_id)"
|
||||
docker cp "$(shell cat .container_id):/project/sphinx_rtd_theme" .
|
||||
docker cp "$(shell cat .container_id):/project/package-lock.json" .
|
||||
@echo "Done building"
|
||||
|
||||
docker-npm-dev:
|
||||
docker-compose run sphinx_rtd_theme dev
|
||||
|
||||
docker-build-all: docker-images docker-npm-build
|
||||
+23
-43
@@ -1,13 +1,14 @@
|
||||
|
||||
**************************
|
||||
Read the Docs Sphinx Theme
|
||||
**************************
|
||||
|
||||
.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
|
||||
:target: https://pypi.python.org/pypi/sphinx_rtd_theme
|
||||
:alt: Pypi Version
|
||||
.. image:: https://circleci.com/gh/readthedocs/sphinx_rtd_theme.svg?style=svg
|
||||
:alt: Pypi Version
|
||||
.. image:: https://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master
|
||||
:target: https://travis-ci.org/rtfd/sphinx_rtd_theme
|
||||
:alt: Build Status
|
||||
:target: https://circleci.com/gh/readthedocs/sphinx_rtd_theme
|
||||
.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
|
||||
:target: https://pypi.python.org/pypi/sphinx_rtd_theme/
|
||||
:alt: License
|
||||
@@ -15,60 +16,39 @@ Read the Docs Sphinx Theme
|
||||
:target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
|
||||
:alt: Documentation Status
|
||||
|
||||
This Sphinx_ theme was designed to provide a great reader experience for
|
||||
documentation users on both desktop and mobile devices. This theme is used
|
||||
primarily on `Read the Docs`_ but can work with any Sphinx project. You can find
|
||||
a working demo of the theme in the `theme documentation`_
|
||||
The ``sphinx_rtd_theme`` is a sphinx_ theme designed to look modern and be mobile-friendly.
|
||||
This theme is primarily focused to be used on readthedocs.org_ but can work with your
|
||||
own sphinx projects. To read more and see a working demo_ head over to readthedocs.org_.
|
||||
|
||||
.. _Sphinx: http://www.sphinx-doc.org
|
||||
.. _Read the Docs: http://www.readthedocs.org
|
||||
.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/
|
||||
.. _sphinx: http://www.sphinx-doc.org
|
||||
.. _readthedocs.org: http://www.readthedocs.org
|
||||
.. _demo: https://sphinx-rtd-theme.readthedocs.io/en/latest/
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
This theme is distributed on PyPI_ and can be installed with ``pip``:
|
||||
Installing
|
||||
==========
|
||||
|
||||
.. code:: console
|
||||
The theme is distributed on PyPI_ and can be installed with pip::
|
||||
|
||||
$ pip install sphinx-rtd-theme
|
||||
pip install sphinx_rtd_theme
|
||||
|
||||
To use the theme in your Sphinx project, you will need to edit
|
||||
your ``conf.py`` file's ``html_theme`` setting:
|
||||
|
||||
.. code:: python
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
.. admonition:: See also:
|
||||
|
||||
`Supported browsers`_
|
||||
Officially supported and tested browser/operating system combinations
|
||||
|
||||
`Supported dependencies`_
|
||||
Supported versions of Python, Sphinx, and other dependencies.
|
||||
|
||||
`Example documentation`_
|
||||
A full example of this theme output, with localized strings enabled.
|
||||
For more information read the full installing docs
|
||||
`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html>`__.
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
|
||||
.. _Supported browsers: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-browsers
|
||||
.. _Supported dependencies: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-dependencies
|
||||
.. _Example documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/
|
||||
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
This theme is highly customizable on both the page level and on a global level.
|
||||
To see all the possible configuration options, read the documentation on
|
||||
`configuring the theme`_.
|
||||
The ``sphinx_rtd_theme`` is highly customizable on both the page level and on a global level.
|
||||
To see all the possible configuration options read the configuring docs
|
||||
`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__.
|
||||
|
||||
.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
|
||||
|
||||
Contributing
|
||||
============
|
||||
|
||||
If you would like to help modify or translate the theme, you'll find more
|
||||
information on contributing in our `contributing guide`_.
|
||||
|
||||
.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/stable/contributing.html
|
||||
If you would like to help improve the theme or have more control
|
||||
over the theme in case of a fork please read our contributing guide
|
||||
`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html>`__.
|
||||
@@ -1,10 +0,0 @@
|
||||
# How setup this file
|
||||
# http://babel.pocoo.org/en/latest/setup.html
|
||||
# this file description:
|
||||
# http://babel.pocoo.org/en/latest/messages.html#extraction-method-mapping-and-configuration
|
||||
|
||||
# Extraction from Jinja2 HTML templates
|
||||
[jinja2: **/**.html]
|
||||
encoding = utf-8
|
||||
ignore_tags = script,style
|
||||
include_attrs = alt title summary placeholder
|
||||
@@ -1,20 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
const package = require('../package.json');
|
||||
|
||||
// Sorry everyone, this is the closest we can get to commenting on package.json
|
||||
// dependencies :(
|
||||
if (package.devDependencies['bourbon-neat'] !== '~1.9') {
|
||||
// Wyrm is not compatible with Neat 2.0+, and Neat 1.9 at least pins a
|
||||
// node-sass version that doesn't require Python 2. The changes to Wyrm to
|
||||
// support Neat 2.0+ are all fairly minor changes, but it deeply affects the
|
||||
// grid system and might be more of a liability than an old release of Neat.
|
||||
// See: https://github.com/readthedocs/sphinx_rtd_theme/pull/771
|
||||
console.error(
|
||||
'bourbon-neat 1.9 is required, Wyrm is not compatible with Neat 2.0+.'
|
||||
);
|
||||
console.error(
|
||||
'The expected selector for the bourbon-neat dependency in package.json is "~1.9".'
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"name": "sphinx-rtd-theme",
|
||||
"version": "0.4.3",
|
||||
"homepage": "https://github.com/rtfd/sphinx_rtd_theme",
|
||||
"authors": [
|
||||
"Dave Snider, Read the Docs, Inc. & contributors <dev@readthedocs.org>"
|
||||
],
|
||||
"description": "Sphinx theme for readthedocs.org.",
|
||||
"license": "MIT",
|
||||
"main": [
|
||||
"js/theme.js"
|
||||
],
|
||||
"ignore": [
|
||||
"docs",
|
||||
".gitignore",
|
||||
".DS_Store",
|
||||
".sass-cache*",
|
||||
".bowerrc",
|
||||
"bower.json",
|
||||
"package.json",
|
||||
"Gruntfile.js",
|
||||
"node_modules",
|
||||
"bower_components",
|
||||
"test",
|
||||
"tests",
|
||||
"src"
|
||||
],
|
||||
"devDependencies": {
|
||||
"wyrm": "~1.0.x"
|
||||
},
|
||||
"dependencies": {
|
||||
"font-awesome": "~4.7"
|
||||
},
|
||||
"resolutions": {
|
||||
"font-awesome": "~4.7"
|
||||
}
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
version: "3.2"
|
||||
services:
|
||||
|
||||
sphinx_rtd_theme:
|
||||
build: .
|
||||
volumes:
|
||||
- type: "bind"
|
||||
source: "./"
|
||||
target: "/project-readonly"
|
||||
read_only: true
|
||||
- type: "volume"
|
||||
target: "/project-readonly/sphinx_rtd_theme.egg-info"
|
||||
- type: "bind"
|
||||
source: "./src"
|
||||
target: "/project/src"
|
||||
read_only: true
|
||||
- type: "bind"
|
||||
source: "./docs"
|
||||
target: "/project/docs"
|
||||
read_only: false #todo: fix this
|
||||
- type: "volume"
|
||||
target: "/project/docs/_build"
|
||||
|
||||
network_mode: host
|
||||
ports:
|
||||
- "1919:1919"
|
||||
@@ -1,25 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Update latest Python dependencies in case they have changed
|
||||
# Notice that we are using the 'eager' strategy
|
||||
# This should only be relevant to development environments where
|
||||
# the theme is being used. For purposes of "production" or
|
||||
# building the sdist/wheel, installing dependencies should not
|
||||
# affect the outcome.
|
||||
cd /project-readonly
|
||||
pip install --upgrade --upgrade-strategy eager -e ".[dev]"
|
||||
|
||||
# This helps a potential permission issue, but might be removed
|
||||
# pending some more investigation of docker host file system
|
||||
# permissions in the bind mount
|
||||
# npm cache clean --force
|
||||
# npm install
|
||||
|
||||
cd /project
|
||||
|
||||
# TODO: This is a bad approach, it copies from the image which
|
||||
# may be outdated to the current git tree
|
||||
cp -r /project-readonly/sphinx_rtd_theme .
|
||||
|
||||
echo "Going to invoke: npm run $@"
|
||||
npm run $@
|
||||
Vendored
-369
@@ -1,369 +0,0 @@
|
||||
{
|
||||
"addons": {
|
||||
"analytics": {
|
||||
"code": null,
|
||||
"enabled": true
|
||||
},
|
||||
"ethicalads": {
|
||||
"ad_free": false,
|
||||
"campaign_types": [
|
||||
"community",
|
||||
"house",
|
||||
"paid"
|
||||
],
|
||||
"enabled": true,
|
||||
"keywords": [
|
||||
"only words"
|
||||
],
|
||||
"publisher": "readthedocs"
|
||||
},
|
||||
"external_version_warning": {
|
||||
"enabled": true
|
||||
},
|
||||
"flyout": {
|
||||
"enabled": true
|
||||
},
|
||||
"hotkeys": {
|
||||
"doc_diff": {
|
||||
"enabled": true,
|
||||
"trigger": "KeyD"
|
||||
},
|
||||
"enabled": true,
|
||||
"search": {
|
||||
"enabled": true,
|
||||
"trigger": "Slash"
|
||||
}
|
||||
},
|
||||
"non_latest_version_warning": {
|
||||
"enabled": true
|
||||
},
|
||||
"search": {
|
||||
"default_filter": "project:sphinx-rtd-theme/stable",
|
||||
"enabled": true,
|
||||
"filters": [
|
||||
[
|
||||
"Include subprojects",
|
||||
"subprojects:sphinx-rtd-theme/stable"
|
||||
]
|
||||
]
|
||||
}
|
||||
},
|
||||
"api_version": "1",
|
||||
"builds": {
|
||||
"current": {
|
||||
"commit": "7c9b1b5d391f6d7fae72274393eb25d1df96e546",
|
||||
"created": "2023-11-28T04:14:06.510677Z",
|
||||
"duration": 42,
|
||||
"error": "",
|
||||
"finished": "2023-11-28T04:14:48.510Z",
|
||||
"id": 22677856,
|
||||
"project": "sphinx-rtd-theme",
|
||||
"state": {
|
||||
"code": "finished",
|
||||
"name": "Finished"
|
||||
},
|
||||
"success": true,
|
||||
"urls": {
|
||||
"build": "https://readthedocs.org/projects/sphinx-rtd-theme/builds/22677856/",
|
||||
"project": "https://readthedocs.org/projects/sphinx-rtd-theme/",
|
||||
"version": "https://readthedocs.org/projects/sphinx-rtd-theme/version/stable/edit/"
|
||||
},
|
||||
"version": "stable"
|
||||
}
|
||||
},
|
||||
"domains": {
|
||||
"dashboard": "readthedocs.org"
|
||||
},
|
||||
"projects": {
|
||||
"current": {
|
||||
"created": "2017-12-21T04:04:42.561793Z",
|
||||
"default_branch": "master",
|
||||
"default_version": "stable",
|
||||
"external_builds_privacy_level": "public",
|
||||
"homepage": null,
|
||||
"id": 170010,
|
||||
"language": {
|
||||
"code": "en",
|
||||
"name": "English"
|
||||
},
|
||||
"modified": "2021-03-16T17:13:52.465051Z",
|
||||
"name": "sphinx_rtd_theme",
|
||||
"privacy_level": "public",
|
||||
"programming_language": {
|
||||
"code": "words",
|
||||
"name": "Only Words"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/readthedocs/sphinx_rtd_theme"
|
||||
},
|
||||
"single_version": false,
|
||||
"slug": "sphinx-rtd-theme",
|
||||
"subproject_of": null,
|
||||
"tags": [],
|
||||
"translation_of": null,
|
||||
"urls": {
|
||||
"builds": "https://readthedocs.org/projects/sphinx-rtd-theme/builds/",
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/stable/",
|
||||
"downloads": "https://readthedocs.org/projects/sphinx-rtd-theme/downloads/",
|
||||
"home": "https://readthedocs.org/projects/sphinx-rtd-theme/",
|
||||
"versions": "https://readthedocs.org/projects/sphinx-rtd-theme/versions/"
|
||||
},
|
||||
"users": [
|
||||
{
|
||||
"username": "eric"
|
||||
},
|
||||
{
|
||||
"username": "humitos"
|
||||
},
|
||||
{
|
||||
"username": "agj"
|
||||
}
|
||||
],
|
||||
"versioning_scheme": "multiple_versions_with_translations"
|
||||
},
|
||||
"translations": []
|
||||
},
|
||||
"readthedocs": {
|
||||
"analytics": {
|
||||
"code": null
|
||||
}
|
||||
},
|
||||
"versions": {
|
||||
"active": [
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 6692534,
|
||||
"identifier": "b07560bf97dad3a4266f6145bd4b662ac708ab00",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "0.5.2",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/0.5.2/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/0.5.2/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/0.5.2/"
|
||||
},
|
||||
"verbose_name": "0.5.2"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 7273098,
|
||||
"identifier": "c9b1bde560d8ee31400e4e4f92f2e8d7a42265ce",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "1.0.0",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/1.0.0/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/1.0.0/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/1.0.0/"
|
||||
},
|
||||
"verbose_name": "1.0.0"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 10496721,
|
||||
"identifier": "f854c890e1445b99a43ac5f10463a5df83739a2e",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "1.1.1",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/1.1.1/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/1.1.1/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/1.1.1/"
|
||||
},
|
||||
"verbose_name": "1.1.1"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 16340532,
|
||||
"identifier": "9899ee4ee2f547f81e51297dc12317f018e62fdd",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "1.2.2",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/1.2.2/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/1.2.2/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/1.2.2/"
|
||||
},
|
||||
"verbose_name": "1.2.2"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 17681643,
|
||||
"identifier": "15ed4de08de55f7066ff4f2ac39883a397db30d3",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "1.3.0",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/1.3.0/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/1.3.0/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/1.3.0/"
|
||||
},
|
||||
"verbose_name": "1.3.0"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 18862205,
|
||||
"identifier": "7c9b1b5d391f6d7fae72274393eb25d1df96e546",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "2.0.0",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/2.0.0/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/2.0.0/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/2.0.0/"
|
||||
},
|
||||
"verbose_name": "2.0.0"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 18862205,
|
||||
"identifier": "7c9b1b5d391f6d7fae72274393eb25d1df96e546",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "2.0.0",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/2.0.0/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/2.0.0/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/2.0.0/"
|
||||
},
|
||||
"verbose_name": "2.0.0"
|
||||
}
|
||||
],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 3271725,
|
||||
"identifier": "7c9b1b5d391f6d7fae72274393eb25d1df96e546",
|
||||
"privacy_level": "public",
|
||||
"ref": "2.0.0",
|
||||
"slug": "stable",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/stable/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/stable/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/2.0.0/"
|
||||
},
|
||||
"verbose_name": "stable"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 3271688,
|
||||
"identifier": "master",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "latest",
|
||||
"type": "branch",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/latest/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/latest/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/master/"
|
||||
},
|
||||
"verbose_name": "latest"
|
||||
}
|
||||
],
|
||||
"current": {
|
||||
"active": true,
|
||||
"aliases": [
|
||||
{
|
||||
"active": true,
|
||||
"aliases": [],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 18862205,
|
||||
"identifier": "7c9b1b5d391f6d7fae72274393eb25d1df96e546",
|
||||
"privacy_level": "public",
|
||||
"ref": null,
|
||||
"slug": "2.0.0",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/2.0.0/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/2.0.0/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/2.0.0/"
|
||||
},
|
||||
"verbose_name": "2.0.0"
|
||||
}
|
||||
],
|
||||
"built": true,
|
||||
"downloads": {},
|
||||
"hidden": false,
|
||||
"id": 3271725,
|
||||
"identifier": "7c9b1b5d391f6d7fae72274393eb25d1df96e546",
|
||||
"privacy_level": "public",
|
||||
"ref": "2.0.0",
|
||||
"slug": "stable",
|
||||
"type": "tag",
|
||||
"urls": {
|
||||
"dashboard": {
|
||||
"edit": "https://readthedocs.org/projects/sphinx-rtd-theme/version/stable/edit/"
|
||||
},
|
||||
"documentation": "https://sphinx-rtd-theme.readthedocs.io/en/stable/",
|
||||
"vcs": "https://github.com/readthedocs/sphinx_rtd_theme/tree/2.0.0/"
|
||||
},
|
||||
"verbose_name": "stable"
|
||||
}
|
||||
}
|
||||
}
|
||||
Vendored
-43
@@ -1,43 +0,0 @@
|
||||
// Add debug actions to flyout menu
|
||||
|
||||
$(function () {
|
||||
$("[data-toggle='rst-debug-badge']").on("click", function () {
|
||||
$("[data-toggle='rst-versions']").toggleClass("rst-badge");
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
const EVENT_READTHEDOCS_ADDONS_DATA_READY = "readthedocs-addons-data-ready";
|
||||
|
||||
fetch("_static/addons.mocked.json", { method: "GET" })
|
||||
.then((response) => {
|
||||
if (!response.ok) {
|
||||
throw new Error("Error downloading Read the Docs Addons mocked data");
|
||||
}
|
||||
return response.json();
|
||||
})
|
||||
.then((data) => {
|
||||
return dispatchEvent(
|
||||
EVENT_READTHEDOCS_ADDONS_DATA_READY,
|
||||
new ReadTheDocsEventData(data),
|
||||
);
|
||||
});
|
||||
|
||||
|
||||
// ``ReadTheDocsEventData`` and ``dispatchEvent``
|
||||
// are borrowed and adapted from Read the Docs Addons.
|
||||
// https://github.com/readthedocs/addons
|
||||
class ReadTheDocsEventData {
|
||||
constructor(data) {
|
||||
this._data = data;
|
||||
}
|
||||
|
||||
data() {
|
||||
return this._data;
|
||||
}
|
||||
}
|
||||
|
||||
function dispatchEvent(eventName, data) {
|
||||
const event = new CustomEvent(eventName, { detail: data });
|
||||
document.dispatchEvent(event);
|
||||
}
|
||||
+30
-396
@@ -2,384 +2,20 @@
|
||||
Changelog
|
||||
*********
|
||||
|
||||
.. seealso:: :ref:`howto_upgrade`
|
||||
|
||||
.. |theme_version| replace:: 3.0.0rc2
|
||||
|
||||
.. _release-3.0.0rc1:
|
||||
|
||||
3.0.0rc2
|
||||
========
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Render version and language selectors below the documentation's title (top left).
|
||||
This can be controlled via the new theme options ``version_selector`` and ``language_selector``.
|
||||
|
||||
|
||||
3.0.0rc1
|
||||
========
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Added support for Sphinx 8.
|
||||
* Added support for Python 3.12.
|
||||
* Added support for docutils ``>0.18, <0.22``.
|
||||
* Populate ``html_context`` with all the environment variables starting with ``READTHEDOCS_``.
|
||||
|
||||
Deprecations
|
||||
------------
|
||||
|
||||
* Drop support for Sphinx ``<6.0``.
|
||||
* Drop support for Python ``<3.8``.
|
||||
* ``analytics_id`` and ``analytics_anonymize_ip`` are deprecated, use sphinxcontrib-googleanalytics_ instead.
|
||||
* Drop support for all versions of Internet Explorer.
|
||||
* Raise a warning when defining ``html_theme_path``. This was an old config that's not required anymore.
|
||||
* ``extra_css_files`` is deprecated and support will be removed in a future version.
|
||||
|
||||
.. _sphinxcontrib-googleanalytics: https://pypi.org/project/sphinxcontrib-googleanalytics/
|
||||
|
||||
.. _release-2.1.0rc2:
|
||||
|
||||
2.1.0rc2
|
||||
========
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Added ``flyout_display`` option to display the flyout
|
||||
``attached`` (bottom of the sidebard) or ``hidden`` (default).
|
||||
|
||||
.. _release-2.1.0rc1:
|
||||
|
||||
2.1.0rc1
|
||||
========
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Render the menu versions/languages selector (flyout)
|
||||
using the new ``readthedocs-addons-data-ready`` Read the Docs Addons ``CustomEvent``.
|
||||
|
||||
Deprecations
|
||||
------------
|
||||
|
||||
* Remove ``html5shiv``.
|
||||
|
||||
.. _release-2.0.0:
|
||||
|
||||
2.0.0
|
||||
=====
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Support for Sphinx versions ``6.x`` and ``7.x``
|
||||
* Support for docutils ``<=0.20``
|
||||
|
||||
Deprecations
|
||||
------------
|
||||
|
||||
* The HTML4 writer is now officially deprecated. An error will be thrown if your
|
||||
project configuration still uses the HTML4 writer.
|
||||
* Support for Sphinx versions < 5.0 was removed.
|
||||
* In addition, our supported dependencies will match the dependencies from our
|
||||
lowest supported Sphinx release, version 5.0: Python >= 3.6 and docutils > 0.14 and < 0.19
|
||||
|
||||
.. _release-1.3.0:
|
||||
|
||||
1.3.0
|
||||
=====
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Relaxed requirements to include Sphinx release ``7.0``
|
||||
|
||||
.. _release-1.2.2:
|
||||
|
||||
1.2.2
|
||||
=====
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Require `sphinxcontrib-jquery>=4,<5` (#1446)
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
* Styling for `:menuselection:` (#1426)
|
||||
|
||||
|
||||
.. _release-1.2.1:
|
||||
|
||||
1.2.1
|
||||
=====
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Load jQuery correctly when using latest sphinxcontrib-jquery release (#1448)
|
||||
|
||||
|
||||
.. _release-1.2.0:
|
||||
|
||||
1.2.0
|
||||
=====
|
||||
|
||||
Dependency changes
|
||||
------------------
|
||||
|
||||
* docutils 0.18 is supported. (#1381)
|
||||
* Sphinx 6 support added
|
||||
* Added ``sphinxcontrib-jquery`` as a dependency (#1385 #1421)
|
||||
* Python 3.11 is officially supported and tested. (#1395)
|
||||
* Python 3.4 and 3.5 are officially not supported (#1395)
|
||||
|
||||
Changes
|
||||
-------
|
||||
|
||||
* Automatically use ``sphinxcontrib-jquery`` in Sphinx 6+ (#1399)
|
||||
* Use new context vars ``logo_url``, ``favicon_url`` and ``root_doc`` when available (#1405)
|
||||
* Translations updated: French, Hungarian, Croatian
|
||||
* Translations added: Danish, Chinese (Taiwan)
|
||||
|
||||
Note for users of Sphinx<4
|
||||
--------------------------
|
||||
|
||||
If you cannot use a more recent Sphinx release,
|
||||
you should at least ensure you are using the most recent release for your major version.
|
||||
Currently, these are Sphinx `1.8.6` and `2.4.5`.
|
||||
Older releases may install unsupported versions of several dependencies, including Jinja2 and docutils.
|
||||
|
||||
Known issues
|
||||
------------
|
||||
|
||||
In some cases, jQuery is not loaded with Sphinx 6 on Read the Docs.
|
||||
Workaround: You need to add ``sphinx_rtd_theme`` to ``extensions`` in your ``conf.py``.
|
||||
See `readthedocs.org issue #9654`_ for updates.
|
||||
|
||||
.. _readthedocs.org issue #9654: https://github.com/readthedocs/readthedocs.org/pull/9654
|
||||
|
||||
|
||||
.. _release-1.1.1:
|
||||
|
||||
1.1.1
|
||||
=====
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Fix wrapping bug on cross references (#1368)
|
||||
|
||||
.. _release-1.1.0:
|
||||
|
||||
1.1.0
|
||||
=====
|
||||
|
||||
Dependency Changes
|
||||
------------------
|
||||
|
||||
Many documentation projects depend on ``sphinx-rtd-theme`` without specifying a version of the theme (unpinned) while also depending on unpinned versions of Sphinx. The latest version of ``sphinx-rtd-theme`` ideally always supports the latest version of Sphinx, but this is now guaranteed.
|
||||
|
||||
This release adds upper bounds to direct dependencies ``Sphinx`` and ``docutils`` which will safeguard from mixing with possibly incompatible future versions of Sphinx & docutils.
|
||||
|
||||
* Sphinx versions supported: 1.6 to 5.2.x
|
||||
* ``Sphinx<6`` (#1332)
|
||||
* ``docutils<0.18`` (unchanged, but will be bumped in an upcoming release)
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* Nicer styles for <kbd> (#967)
|
||||
* New styling for breadcrumbs (#1073)
|
||||
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Suffixes in Sphinx version caused build errors (#1345)
|
||||
* Table cells with multiple paragraphs gets wrong formatting (#289)
|
||||
* Definition lists rendered wrongly in api docs (#1052)
|
||||
* Citation not styled properly (#1078)
|
||||
* Long URLs did not wrap (#1193)
|
||||
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
* Sphinx 5.2 added to test matrix (#1348)
|
||||
* Python 3.10 added to test matrix (#1334)
|
||||
* Supplemental Docker setup for development (#1319)
|
||||
* Most of setup.py migrated to setup.cfg (#1116)
|
||||
* Jinja2 context variable ``sphinx_version_info`` is now ``(major, minor, -1)``, the patch component is always ``-1``. Reason: It's complicated. (#1345)
|
||||
|
||||
|
||||
Incompatible Changes
|
||||
--------------------
|
||||
|
||||
There are no known incompatible changes in this release. Support for ``docutils`` versions 0.18 and 0.19 are scheduled for our next release.
|
||||
|
||||
|
||||
.. _release-1.0.0:
|
||||
|
||||
1.0.0
|
||||
=====
|
||||
|
||||
Incompatible Changes
|
||||
--------------------
|
||||
|
||||
* The minimum supported python version is now 2.7 or 3.4 and greater (#1093)
|
||||
* The minimum supported Sphinx version is now 1.6 (#1091)
|
||||
|
||||
Deprecated
|
||||
----------
|
||||
|
||||
* Support for Sphinx's HTML4 writer is deprecated and will be removed in version 2.0 (#1091)
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* Add support for Sphinx 4.x (#1123)
|
||||
* Add support for Docutils 0.17 (#1185 and #1199)
|
||||
* Fixed logo scaling on IE11 (#1183)
|
||||
* Added support for logos as URLs (#1171)
|
||||
* Align top and side navigation background colors on mobile (#1132)
|
||||
* Added support for deep toc levels (#1089)
|
||||
* Updated translations for Chinese, Dutch, Estonian, French, German, Italian,
|
||||
Lithuanian, Persian, Polish, Portuguese, Russian, Spanish, Swedish, and
|
||||
Turkish locales
|
||||
|
||||
A number of accessibility features were added in this release:
|
||||
|
||||
* Allow keyboard to toggle menu expansion (#1167)
|
||||
* Allow keyboard to activate permalink (#1162)
|
||||
* Show keyboard focus on buttons (#1161)
|
||||
* Maintain aria-expanded along with .current in menu (#1151)
|
||||
* Respect tab order for prev/next buttons (#1051)
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Updated Google analytics integration (#1129)
|
||||
* Add classifier separation on Sphinx 2+ HTML4 writer (#1192)
|
||||
* Added missing space char in footer (#1188)
|
||||
* Fix navigation right padding on level2+ elements (#1068)
|
||||
* Fix navigation expansion button sizes (#1067)
|
||||
* Wrap inline literals (#1050)
|
||||
* Fix aria labels (#1056)
|
||||
* Don't toggle navigation terminal nodes (#1049)
|
||||
* Fix ``<pre>`` overflow (#1220)
|
||||
* Fix literal/ref style inside ``<dl>`` (#1088)
|
||||
|
||||
Other Changes
|
||||
-------------
|
||||
|
||||
* Update npm development dependencies (#1096)
|
||||
* Don't require npm to build from source (#1039)
|
||||
* Use regular toctree instead of toc for singlehtml builder (#507)
|
||||
* Cleanup whitespace in templates (#1060)
|
||||
|
||||
.. _release-0.5.2:
|
||||
|
||||
0.5.2
|
||||
=====
|
||||
|
||||
:Date: April 5, 2021
|
||||
|
||||
.. note:: This commit will not be in ``master``, but was branched directly off ``0.5.1`` to minimize issues.
|
||||
The next full release will contain all PR's previously merged.
|
||||
|
||||
* Depend on docutils < 0.17 (#1113)
|
||||
|
||||
.. _release-0.5.1:
|
||||
|
||||
0.5.1
|
||||
=====
|
||||
|
||||
:Date: January 4, 2021
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Set ``url_root`` properly on index (#1025)
|
||||
* Do not load ``language_data.js`` in non-search pages (#1021)
|
||||
* Hide the search box on any ``singlehtml`` like builder (#975)
|
||||
* Fix ``vcs_pageview_mode`` template parameter (#1010)
|
||||
* Mark nex/prev icons as aria-hidden (#1007)
|
||||
* Use well-formed XML syntax (#1006)
|
||||
* Footer: show both ``commit`` and ``last_updated`` if available (#897)
|
||||
* Search page: don't show "edit on" links (#935)
|
||||
master
|
||||
======
|
||||
|
||||
New Features
|
||||
------------
|
||||
|
||||
* New theme option to enable anonymous ip addresses when using Google Analytics (#889)
|
||||
|
||||
Other Changes
|
||||
-------------
|
||||
|
||||
* The ``canonical_url`` option was deprecated in favor of Sphinx's ``html_baseurl`` (#1003)
|
||||
* Add ``contentinfo`` block to ``footer.html`` template (#896)
|
||||
* Make Copyright template match sphinx's basic (#933)
|
||||
* Packaging: include ``bin/preinstall.js`` (#1005)
|
||||
|
||||
.. _release-0.5.0:
|
||||
|
||||
0.5.0
|
||||
=====
|
||||
|
||||
:Date: Jun 17, 2020
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Fix bullet list spacing to respect simple/complex list styles
|
||||
|
||||
.. _release-0.5.0rc2:
|
||||
|
||||
0.5.0rc2
|
||||
========
|
||||
|
||||
:Date: June 5, 2020
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Fix issue with simple definition lists that was missed
|
||||
* Change FOUT back to FOIT
|
||||
* Fix several margin issues with lists, nested lists, and nested content
|
||||
* Add colon back to field lists
|
||||
|
||||
.. _release-0.5.0rc1:
|
||||
|
||||
0.5.0rc1
|
||||
========
|
||||
|
||||
:Date: May 6, 2020
|
||||
|
||||
Fixes
|
||||
-----
|
||||
|
||||
* Fix many styling issues that look different when using the Sphinx HTML5 writer
|
||||
|
||||
Other Changes
|
||||
--------------
|
||||
|
||||
* Add the ``navigation`` template block around the navigation area.
|
||||
* Added i18n support using Babel
|
||||
* Added translations for 10 new languages
|
||||
* Moved build system from Grunt and friends to Webpack
|
||||
* Remove Modernizr, but keep html5shiv (#724, #525)
|
||||
|
||||
.. _release-0.4.3:
|
||||
|
||||
0.4.3
|
||||
=====
|
||||
======
|
||||
|
||||
:Date: Feb 12, 2019
|
||||
|
||||
@@ -398,10 +34,8 @@ Fixes
|
||||
Other Changes
|
||||
--------------
|
||||
|
||||
.. _release-0.4.2:
|
||||
|
||||
0.4.2
|
||||
=====
|
||||
v0.4.2
|
||||
======
|
||||
|
||||
:Date: Oct 5, 2018
|
||||
|
||||
@@ -420,8 +54,8 @@ Other Changes
|
||||
* Upload signed packages to PyPI with twine (#651)
|
||||
* Do not enforce period at the end of copyright statement (666)
|
||||
|
||||
0.4.1
|
||||
=====
|
||||
v0.4.1
|
||||
======
|
||||
|
||||
:Date: July 27, 2018
|
||||
|
||||
@@ -438,8 +72,8 @@ Other Changes
|
||||
|
||||
* Add Sphinx as a dependency
|
||||
|
||||
0.4.0
|
||||
=====
|
||||
v0.4.0
|
||||
======
|
||||
|
||||
This version made some changes to how JS and CSS were included
|
||||
when the theme is used on Read the Docs.
|
||||
@@ -455,14 +89,14 @@ Fixes
|
||||
* Color accessibility improvements on the left navigation
|
||||
|
||||
Other Changes
|
||||
---------------
|
||||
--------------
|
||||
|
||||
* Write theme version and build date at top of JavaScript and CSS
|
||||
* Changed code and literals to use a native font stack (#612)
|
||||
* Fix small styling issues
|
||||
|
||||
0.3.1
|
||||
=====
|
||||
v0.3.1
|
||||
======
|
||||
|
||||
Fixes
|
||||
-----
|
||||
@@ -473,8 +107,8 @@ Fixes
|
||||
* Add open list spacing (#591)
|
||||
* Fix table centering (#599)
|
||||
|
||||
0.3.0
|
||||
=====
|
||||
v0.3.0
|
||||
======
|
||||
|
||||
**Note**: this version resulted in some JavaScript incompatibilities when used on readthedocs.org
|
||||
|
||||
@@ -507,40 +141,40 @@ Other Changes
|
||||
* Compress our Javascript files
|
||||
* Updated dependencies
|
||||
|
||||
0.2.4
|
||||
=====
|
||||
v0.2.4
|
||||
======
|
||||
|
||||
* Yet another patch to deal with extra builders outside Spinx, such as the
|
||||
singlehtml builders from the Read the Docs Sphinx extension
|
||||
|
||||
0.2.3
|
||||
=====
|
||||
v0.2.3
|
||||
======
|
||||
|
||||
* Temporarily patch Sphinx issue with ``singlehtml`` builder by inspecting the
|
||||
builder in template.
|
||||
|
||||
0.2.2
|
||||
=====
|
||||
v0.2.2
|
||||
======
|
||||
|
||||
* Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and
|
||||
introduced another bug with toctrees display.
|
||||
|
||||
0.2.1
|
||||
=====
|
||||
v0.2.1
|
||||
======
|
||||
|
||||
* Add the ``rel`` HTML attribute to the footer links which point to
|
||||
the previous and next pages.
|
||||
* Fix toctree issue caused by Sphinx singlehtml builder (#367)
|
||||
|
||||
0.2.0
|
||||
=====
|
||||
v0.2.0
|
||||
======
|
||||
|
||||
* Adds the ``comments`` block after the ``body`` block in the template
|
||||
* Added "Edit on GitLab" support
|
||||
* Many bug fixes
|
||||
|
||||
0.1.10-alpha
|
||||
============
|
||||
v0.1.10-alpha
|
||||
=============
|
||||
|
||||
.. note:: This is a pre-release version
|
||||
|
||||
@@ -549,8 +183,8 @@ Other Changes
|
||||
* Adds a ``body_begin`` block to the template
|
||||
* Added ``prev_next_buttons_location``
|
||||
|
||||
0.1.9
|
||||
=====
|
||||
v0.1.9
|
||||
======
|
||||
|
||||
* Intermittent scrollbar visibility bug fixed. This change introduces a
|
||||
backwards incompatible change to the theme's layout HTML. This should only be
|
||||
@@ -566,8 +200,8 @@ Other Changes
|
||||
|
||||
.. _#215: https://github.com/rtfd/sphinx_rtd_theme/pull/215
|
||||
|
||||
0.1.8
|
||||
=====
|
||||
v0.1.8
|
||||
======
|
||||
|
||||
* Start keeping changelog :)
|
||||
* Support for third and fourth level headers in the sidebar
|
||||
|
||||
+11
-30
@@ -4,19 +4,18 @@ import sys
|
||||
import os
|
||||
import re
|
||||
|
||||
# Prefer to use the version of the theme in this repo
|
||||
# and not the installed version of the theme.
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
sys.path.append(os.path.abspath('..'))
|
||||
sys.path.append(os.path.abspath('./demo/'))
|
||||
|
||||
from sphinx_rtd_theme import __version__ as theme_version
|
||||
from sphinx_rtd_theme import __version_full__ as theme_version_full
|
||||
from sphinx.locale import _
|
||||
|
||||
from sphinx_rtd_theme import __version__
|
||||
|
||||
|
||||
project = u'Read the Docs Sphinx Theme'
|
||||
slug = re.sub(r'\W+', '-', project.lower())
|
||||
version = theme_version
|
||||
release = theme_version_full
|
||||
version = __version__
|
||||
release = __version__
|
||||
author = u'Dave Snider, Read the Docs, Inc. & contributors'
|
||||
copyright = author
|
||||
language = 'en'
|
||||
@@ -24,52 +23,34 @@ language = 'en'
|
||||
extensions = [
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.autosummary',
|
||||
'sphinx.ext.mathjax',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx_rtd_theme',
|
||||
'sphinxcontrib.httpdomain',
|
||||
]
|
||||
|
||||
templates_path = ['_templates']
|
||||
source_suffix = '.rst'
|
||||
exclude_patterns = []
|
||||
locale_dirs = ['locale/']
|
||||
gettext_compact = False
|
||||
|
||||
master_doc = 'index'
|
||||
suppress_warnings = ['image.nonlocal_uri']
|
||||
pygments_style = 'default'
|
||||
|
||||
if sys.version_info < (3, 0):
|
||||
tags.add("python2")
|
||||
else:
|
||||
tags.add("python3")
|
||||
|
||||
intersphinx_mapping = {
|
||||
'rtd': ('https://docs.readthedocs.io/en/stable/', None),
|
||||
'rtd-dev': ('https://dev.readthedocs.io/en/stable/', None),
|
||||
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
|
||||
'rtd': ('https://docs.readthedocs.io/en/latest/', None),
|
||||
'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
|
||||
}
|
||||
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
html_theme_options = {
|
||||
'logo_only': True,
|
||||
'navigation_depth': 5,
|
||||
'logo_only': True
|
||||
}
|
||||
html_context = {}
|
||||
|
||||
if not 'READTHEDOCS' in os.environ:
|
||||
html_static_path = ['_static/']
|
||||
html_js_files = ['debug.js']
|
||||
html_context["DEBUG"] = True
|
||||
|
||||
html_theme_path = ["../.."]
|
||||
html_logo = "demo/static/logo-wordmark-light.svg"
|
||||
html_show_sourcelink = True
|
||||
html_favicon = "demo/static/favicon.ico"
|
||||
|
||||
htmlhelp_basename = slug
|
||||
|
||||
|
||||
latex_documents = [
|
||||
('index', '{0}.tex'.format(slug), project, author, 'manual'),
|
||||
]
|
||||
|
||||
+44
-97
@@ -13,16 +13,14 @@ For example:
|
||||
.. code:: python
|
||||
|
||||
html_theme_options = {
|
||||
'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard
|
||||
'analytics_anonymize_ip': False,
|
||||
'canonical_url': '',
|
||||
'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
|
||||
'logo_only': False,
|
||||
'display_version': True,
|
||||
'prev_next_buttons_location': 'bottom',
|
||||
'style_external_links': False,
|
||||
'vcs_pageview_mode': '',
|
||||
'style_nav_header_background': 'white',
|
||||
'flyout_display': 'hidden',
|
||||
'version_selector': True,
|
||||
'language_selector': True,
|
||||
# Toc options
|
||||
'collapse_navigation': True,
|
||||
'sticky_navigation': True,
|
||||
@@ -39,49 +37,49 @@ documentation navigation.
|
||||
|
||||
.. confval:: collapse_navigation
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
With this enabled, navigation entries are not expandable -- the ``[+]``
|
||||
icons next to each entry are removed.
|
||||
|
||||
.. confval:: sticky_navigation
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
.. note::
|
||||
Setting :confval:`collapse_navigation` to ``False`` and using a high value
|
||||
for :confval:`navigation_depth` on projects with many files and a deep file
|
||||
structure can cause long compilation times and can result in HTML files that
|
||||
are significantly larger in file size.
|
||||
|
||||
.. confval:: sticky_navigation
|
||||
|
||||
Scroll the navigation with the main page content as you scroll the page.
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
.. confval:: navigation_depth
|
||||
|
||||
The maximum depth of the table of contents tree. Set
|
||||
this to ``-1`` to allow unlimited depth.
|
||||
|
||||
:type: integer
|
||||
:default: ``4``
|
||||
|
||||
The maximum depth of the table of contents tree. Set
|
||||
this to ``-1`` to allow unlimited depth.
|
||||
|
||||
.. confval:: includehidden
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
Specifies if the navigation includes hidden table(s) of contents -- that is,
|
||||
any :rst:dir:`sphinx:toctree` directive that is marked with the ``:hidden:``
|
||||
option.
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
.. confval:: titles_only
|
||||
|
||||
:type: boolean
|
||||
:default: False
|
||||
|
||||
When enabled, page subheadings are not included in the
|
||||
navigation.
|
||||
|
||||
:type: boolean
|
||||
:default: False
|
||||
.. note::
|
||||
Setting :confval:`collapse_navigation` to ``False`` and using a high value
|
||||
for :confval:`navigation_depth` on projects with many files and a deep file
|
||||
structure can cause long compilation times and can result in HTML files that
|
||||
are significantly larger in file size.
|
||||
|
||||
.. _table of contents configuration options: http://www.sphinx-doc.org/en/stable/templating.html#toctree
|
||||
|
||||
@@ -98,124 +96,72 @@ Miscellaneous options
|
||||
|
||||
.. confval:: analytics_id
|
||||
|
||||
If specified, Google Analytics' `gtag.js`_ is included in your pages.
|
||||
Set the value to the ID provided to you by google (like ``UA-XXXXXXX`` or ``G-XXXXXXXXXX``).
|
||||
|
||||
:type: string
|
||||
|
||||
.. deprecated:: 3.0.0
|
||||
The ``analytics_id`` option is deprecated, use the sphinxcontrib-googleanalytics_ extension instead.
|
||||
Change the Google Analytics ID that is included on pages.
|
||||
|
||||
.. _gtag.js: https://developers.google.com/gtagjs
|
||||
.. _sphinxcontrib-googleanalytics: https://pypi.org/project/sphinxcontrib-googleanalytics/
|
||||
|
||||
.. confval:: analytics_anonymize_ip
|
||||
|
||||
Anonymize visitor IP addresses in Google Analytics.
|
||||
|
||||
:type: boolean
|
||||
:default: ``False``
|
||||
|
||||
.. deprecated:: 3.0.0
|
||||
The ``analytics_anonymize_ip`` option is deprecated, use the sphinxcontrib-googleanalytics_ extension instead.
|
||||
.. warning::
|
||||
This configuration option is not yet used.
|
||||
|
||||
.. confval:: canonical_url
|
||||
|
||||
:type: URL
|
||||
|
||||
This will specify a `canonical URL`_ meta link element to tell search
|
||||
engines which URL should be ranked as the primary URL for your
|
||||
documentation. This is important if you have multiple URLs that your
|
||||
documentation is available through. The URL points to the root path of the
|
||||
documentation and requires a trailing slash.
|
||||
|
||||
:type: URL
|
||||
|
||||
.. deprecated:: 0.6.0
|
||||
|
||||
Use :confval:`sphinx:html_baseurl` instead.
|
||||
|
||||
.. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
|
||||
|
||||
.. confval:: display_version
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
If ``True``, the version number is shown at the top of the sidebar.
|
||||
|
||||
.. confval:: logo_only
|
||||
|
||||
:type: boolean
|
||||
:default: ``False``
|
||||
|
||||
.. deprecated:: 3.0.0
|
||||
|
||||
Removed in favor of ``version_selector`` and ``language_selector``.
|
||||
|
||||
.. confval:: logo_only
|
||||
|
||||
Only display the logo image, do not display the project name at the top of
|
||||
the sidebar
|
||||
|
||||
:type: boolean
|
||||
:default: ``False``
|
||||
|
||||
.. confval:: prev_next_buttons_location
|
||||
|
||||
Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
|
||||
can be either ``bottom``, ``top``, ``both`` , or ``None``.
|
||||
|
||||
:type: string
|
||||
:default: ``bottom``
|
||||
|
||||
.. confval:: style_external_links
|
||||
Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
|
||||
can be either ``bottom``, ``top``, ``both`` , or ``None``.
|
||||
|
||||
Add an icon next to external links.
|
||||
.. confval:: style_external_links
|
||||
|
||||
:type: boolean
|
||||
:default: ``False``
|
||||
|
||||
Add an icon next to external links.
|
||||
|
||||
.. confval:: vcs_pageview_mode
|
||||
|
||||
:type: string
|
||||
:default: ``blob`` or ``view``
|
||||
|
||||
Changes how to view files when using ``display_github``, ``display_gitlab``,
|
||||
etc. When using GitHub or GitLab this can be: ``blob`` (default), ``edit``,
|
||||
or ``raw``. On Bitbucket, this can be either: ``view`` (default) or
|
||||
``edit``.
|
||||
|
||||
:type: string
|
||||
:default: ``blob`` or ``view``
|
||||
|
||||
.. confval:: style_nav_header_background
|
||||
|
||||
Changes the background of the search area in the navigation bar. The value
|
||||
can be anything valid in a CSS `background` property.
|
||||
|
||||
:type: string
|
||||
:default: ``#2980B9``
|
||||
|
||||
.. confval:: flyout_display
|
||||
Changes the background of the search area in the navigation bar. The value
|
||||
can be anything valid in a CSS `background` property.
|
||||
|
||||
Specify how to display the flyout (language and version selector).
|
||||
This can be either ``attached`` or ``hidden``.
|
||||
``attached`` means that it will show the flyout in the bottom of the sidebar.
|
||||
You will need to disable the default `Read the Docs flyout <https://docs.readthedocs.io/en/stable/flyout-menu.html>`_ in order to not have 2 flyouts showing.
|
||||
|
||||
:type: str
|
||||
:default: ``hidden``
|
||||
|
||||
.. confval:: version_selector
|
||||
|
||||
Display a version selector below the title.
|
||||
This feature makes usage of `Read the Docs Addons <https://docs.readthedocs.io/page/addons.html>`_ for this,
|
||||
so it's required the documentation to be hosted on Read the Docs.
|
||||
It only appears when there are more than 1 active version.
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
|
||||
.. confval:: language_selector
|
||||
|
||||
Display a language selector below the title.
|
||||
This feature makes usage of `Read the Docs Addons <https://docs.readthedocs.io/page/addons.html>`_ for this,
|
||||
so it's required the documentation to be served on Read the Docs.
|
||||
It only appears when there is more than 1 active language.
|
||||
|
||||
:type: boolean
|
||||
:default: ``True``
|
||||
.. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
|
||||
|
||||
|
||||
File-wide metadata
|
||||
@@ -236,6 +182,7 @@ The following options can be used as :ref:`file-wide metadata
|
||||
|
||||
Force the :guilabel:`Edit on GitLab` button to use the configured URL.
|
||||
|
||||
|
||||
Other configuration
|
||||
===================
|
||||
|
||||
|
||||
+54
-231
@@ -1,266 +1,89 @@
|
||||
************
|
||||
Contributing
|
||||
************
|
||||
|
||||
This project follows the Read the Docs :doc:`code of conduct
|
||||
<rtd-dev:code-of-conduct>`. If you are not familiar with our code of conduct policy,
|
||||
take a minute to read the policy before starting with your first contribution.
|
||||
***********************************
|
||||
Contributing or modifying the theme
|
||||
***********************************
|
||||
|
||||
.. tip::
|
||||
There is a new dockerized build environment, see :ref:`dockerized-build`.
|
||||
The sphinx_rtd_theme is primarily a sass_ project that requires a few other sass libraries. I'm
|
||||
using bower_ to manage these dependencies and sass_ to build the css. The good news is
|
||||
I have a very nice set of grunt_ operations that will not only load these dependencies, but watch
|
||||
for changes, rebuild the sphinx demo docs and build a distributable version of the theme.
|
||||
The bad news is this means you'll need to set up your environment similar to that
|
||||
of a front-end developer (vs. that of a python developer). That means installing node and ruby.
|
||||
|
||||
Modifying the theme
|
||||
===================
|
||||
.. seealso::
|
||||
|
||||
The styles for this theme use SASS_ and a custom CSS framework called Wyrm_. We
|
||||
use Webpack_ and node-sass_ to build the CSS. Webpack_ is used to watch for
|
||||
changes, rebuild the static assets, and rebuild the Sphinx demo documentation.
|
||||
If you are unsure of appropriate actions to take while interacting with our
|
||||
community please read our :doc:`Code of Conduct <rtd:code-of-conduct>`.
|
||||
|
||||
.. note::
|
||||
The installation of Node is outside the scope of this documentation. You
|
||||
will need Node version 10+ in order to make changes to this theme.
|
||||
|
||||
Set up your environment
|
||||
-----------------------
|
||||
=======================
|
||||
|
||||
#. Install Sphinx_ and documentation build dependencies.
|
||||
#. Install sphinx_ into a virtual environment.
|
||||
|
||||
.. code:: console
|
||||
.. code:: bash
|
||||
|
||||
$ pip install -e '.[dev]'
|
||||
pip install sphinx sphinxcontrib-httpdomain
|
||||
|
||||
#. Install Webpack_, node-sass_, and theme dependencies locally.
|
||||
#. Install sass.
|
||||
|
||||
.. code:: console
|
||||
.. code:: bash
|
||||
|
||||
$ npm install
|
||||
gem install sass
|
||||
|
||||
Making changes
|
||||
--------------
|
||||
#. Install node, bower, grunt, and theme dependencies.
|
||||
|
||||
Changes to the theme can be compiled and tested with Webpack_:
|
||||
.. code:: bash
|
||||
|
||||
.. code:: console
|
||||
# Install node
|
||||
brew install node
|
||||
|
||||
$ npm run dev
|
||||
# Install bower and grunt
|
||||
npm install -g bower grunt-cli
|
||||
|
||||
This script will do the following:
|
||||
# Now that everything is installed, let's install the theme dependencies.
|
||||
npm install
|
||||
|
||||
#. Install and update any dependencies.
|
||||
#. Build the static CSS from SASS source files.
|
||||
#. Build the demo documentation.
|
||||
#. Watch for changes to the SASS files and documentation and rebuild everything
|
||||
on any detected changes.
|
||||
Now that our environment is set up, make sure you're in your virtual environment, go to
|
||||
this repository in your terminal and run grunt:
|
||||
|
||||
Alternatively, if you don't need to watch the files, the release build script
|
||||
can be used to test built assets:
|
||||
.. code::
|
||||
|
||||
.. code:: console
|
||||
grunt
|
||||
|
||||
$ npm run build
|
||||
This default task will do the following **very cool things that make it worth the trouble**:
|
||||
|
||||
.. _Webpack: https://webpack.js.org/
|
||||
.. _node-sass: https://github.com/sass/node-sass
|
||||
.. _SASS: http://www.sass-lang.com
|
||||
.. _Wyrm: http://www.github.com/snide/wyrm/
|
||||
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
|
||||
#. Install and update any bower dependencies.
|
||||
#. Run sphinx and build new docs.
|
||||
#. Watch for changes to the sass files and build css from the changes.
|
||||
#. Rebuild the sphinx docs anytime it notices a change to ``.rst``, ``.html``, ``.js``
|
||||
or ``.css`` files.
|
||||
|
||||
.. _bower: http://www.bower.io
|
||||
.. _sass: http://www.sass-lang.com
|
||||
.. _wyrm: http://www.github.com/snide/wyrm/
|
||||
.. _grunt: http://www.gruntjs.com
|
||||
.. _node: http://www.nodejs.com
|
||||
.. _sphinx: http://www.sphinx-doc.org/en/stable/
|
||||
|
||||
.. _dockerized-build:
|
||||
|
||||
Dockerized development
|
||||
======================
|
||||
|
||||
If you have Docker available on your platform, you can get started building CSS and JS artifacts a bit faster and won't have to worry about any of the setup spilling over into your general environment.
|
||||
|
||||
When building with Docker, we create an image containing the build dependencies. Some of these are quite outdated and therefore ideal to isolate a container. The image is tagged as ``sphinx_rtd_theme:latest``.
|
||||
|
||||
Inside the running docker image, we mount the working copy of the repository, build the artifacts and finally observe that the artifacts have been built and left in your current git checkout.
|
||||
|
||||
Use the following steps:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# Builds an updated version of the docker image
|
||||
$ docker-compose build
|
||||
|
||||
# Runs the development webserver
|
||||
$ docker-compose run sphinx_rtd_theme dev
|
||||
|
||||
# If you want to copy stuff out of the Docker environment, run this make
|
||||
# target or read the actual Makefile to see what is going on.
|
||||
# We suggest running this command every time that you want to quickly build
|
||||
# new CSS/JS assets
|
||||
$ make docker-build-all
|
||||
|
||||
Every time you change the Node or Python requirements, you will need to rebuild images with ``docker-compose run sphinx_rtd_theme build``. If you change SASS or JS, you will need to rebuild assets.
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
QA testing theme changes and pull requests is complex, due to backwards
|
||||
compatibility.
|
||||
|
||||
The following cases need to be tested with changes to CSS or JavaScript:
|
||||
|
||||
* Multiple, modern browsers should be tested.
|
||||
* Multiple viewport sizes should be tested for changes.
|
||||
We support large, tablet, and mobile viewport sizes
|
||||
* We currently support only HTML5 writer.
|
||||
* Multiple major versions of Sphinx should be tested.
|
||||
We currently support Sphinx ``>=6.0``
|
||||
|
||||
It's easiest to test combinations of dependency versions using ``tox``:
|
||||
|
||||
.. code:: console
|
||||
|
||||
% tox -e py312-sphinx74
|
||||
|
||||
If the tests and build are successful, you can view the built documentation at
|
||||
the directory noted by Sphinx:
|
||||
|
||||
.. code:: console
|
||||
|
||||
build succeeded, 10 warnings.
|
||||
|
||||
The HTML pages are in .tox/py312-sphinx74/tmp/html.
|
||||
___________________________ summary ___________________________
|
||||
py312-sphinx74: commands succeeded
|
||||
congratulations :)
|
||||
|
||||
You can then open up this path with a series of browsers to test.
|
||||
|
||||
The best way to spot UI issues is to compare two or more builds. You can build
|
||||
multiple ``tox`` environments, and open both up for comparison:
|
||||
|
||||
.. code:: console
|
||||
|
||||
% tox -e py312-sphinx62
|
||||
...
|
||||
% tox -e py312-sphinx74
|
||||
...
|
||||
% firefox .tox/py312-sphinx62/tmp/html/index.html
|
||||
% firefox .tox/py312-sphinx74/tmp/html/index.html
|
||||
|
||||
You can also use a separate ``tox`` environment for building output to compare
|
||||
against. All of the ``tox`` environments have an additional postfix, ``-qa``, to
|
||||
allow building the same environment twice, without overwriting any files. In
|
||||
this test scenario, you would build from a branch or tag before building the
|
||||
same ``tox`` environment for the pull request branch you are testing.
|
||||
|
||||
For example, to test against the tag ``0.5.2``:
|
||||
|
||||
.. code:: console
|
||||
|
||||
% git checkout 0.5.2
|
||||
% tox -e py310-sphinx53-qa
|
||||
...
|
||||
% git checkout feature/example-pull-request
|
||||
% tox -e py310-sphinx53
|
||||
...
|
||||
% firefox .tox/py310-sphinx53-qa/tmp/html/index.html
|
||||
% firefox .tox/py310-sphinx53/tmp/html/index.html
|
||||
|
||||
Currently, the most important environments to QA are:
|
||||
|
||||
.. This list is purposely shorter than what we describe above. If we test all of
|
||||
the cases above, we'll be here all day. Python 3, and latest
|
||||
minor of each major Sphinx release should give us enough work.
|
||||
|
||||
* ``py312-sphinx62``
|
||||
* ``py312-sphinx74``
|
||||
* ``py312-sphinx80``
|
||||
* ``py312-sphinxlatest``
|
||||
* ``py312-sphinxdev``
|
||||
|
||||
Translations
|
||||
============
|
||||
|
||||
Translations are managed using `Transifex`_. You can join any of the existing
|
||||
language teams or request a new language is added to the project. For more
|
||||
information on our translation standards, see our docs on
|
||||
:doc:`rtd-dev:i18n`
|
||||
|
||||
Periodically, core team should update the translation files outside our normal
|
||||
releases. Someone from the core team, with write access to Transifex, should run
|
||||
the following:
|
||||
|
||||
.. code:: console
|
||||
|
||||
$ python setup.py update_translations
|
||||
|
||||
This will extract new messages, upload the messages to Transifex, and will
|
||||
update our local translation files. Changes can be checked in to a branch and
|
||||
put up for review.
|
||||
|
||||
.. _Transifex: https://www.transifex.com/readthedocs/sphinx-rtd-theme
|
||||
|
||||
Versioning
|
||||
==========
|
||||
|
||||
..
|
||||
TODO make these instructions organization wide. We've talked about
|
||||
standardizing packaging version and tooling here (bumpver instead of
|
||||
bump2version).
|
||||
|
||||
In between releases, the package version specified will always be a alpha
|
||||
release, matching ``1.1.1alpha1``.
|
||||
|
||||
As pull requests are merged and the release impact changes, this version will
|
||||
incremented ahead of release. For example, if we merge a new feature pull
|
||||
request, we'd run ``bump2version minor`` to increment ``1.1.1alpha1`` to
|
||||
``1.2.0alpha1``.
|
||||
|
||||
To put out a release for testing, we will upload a release candidate. We would
|
||||
run ``bump2version release`` to increment ``1.2.0alpha1`` to ``1.2.0rc1``.
|
||||
|
||||
After a testing period, the release candidate can become a full release. We
|
||||
would run ``bump2version release`` again to increment ``1.2.0rc1`` to ``1.2.0``.
|
||||
|
||||
After the release process below, we increment the version again, so that the
|
||||
development version -- the version found in the repository -- is always greater
|
||||
than the most recent release. We follow up with another pull request by running
|
||||
``bump2version patch``, which increments ``1.2.0`` to ``1.2.1alpha1``.
|
||||
|
||||
Releasing the theme
|
||||
Releasing the Theme
|
||||
===================
|
||||
|
||||
To release a new version of the theme, core team will take the following steps:
|
||||
When you release a new version,
|
||||
you should do the following:
|
||||
|
||||
#. Install the required depedencies with ``pip install '.[dev]'``.
|
||||
#. Bump the version by running ``bump2version [major|minor|patch|dev]``.
|
||||
This will automatically increase the correct part(s) of the version number,
|
||||
you do not need to specify the exact version number.
|
||||
We follow `semantic versioning`_ and `PEP440`_
|
||||
(with regards to alpha release and development versions). The version
|
||||
increment should reflect these releases and any potentially breaking changes.
|
||||
#. New versions are by default ``alpha`` releases. If this is a release candidate,
|
||||
run ``bump2version --allow-dirty release`` to update the release to an ``rc``
|
||||
release. If this is a final release, run the command again.
|
||||
#. Bump the version in ``sphinx_rtd_theme/__init__.py``, ``bower.json`` and ``package.json`` --
|
||||
we try to follow `semver <http://semver.org/>`_, so be careful with breaking changes.
|
||||
#. Update the changelog (``docs/changelog.rst``) with the version information.
|
||||
#. Run ``python setup.py update_translations`` to compile new translation files
|
||||
and update Transifex.
|
||||
#. Run ``npm install && npm run build`` to rebuild all the theme assets,
|
||||
notice that ``package-lock.json`` will be updated with a new package
|
||||
version. But take care that it isn't also bumping versions of dependencies
|
||||
in ways that are risky to the release. *If* ``package-lock.json`` changes, you
|
||||
need to commit it to git and tag it together with your release.
|
||||
#. Commit these changes to a pull request.
|
||||
#. Merge the pull request after review.
|
||||
#. Check out ``master`` branch locally for tagging. **Remember to pull from remote**.
|
||||
#. Run a ``grunt build`` to rebuild all the theme assets.
|
||||
#. Commit that change.
|
||||
#. Tag the release in git: ``git tag $NEW_VERSION``.
|
||||
#. Push the tag to GitHub: ``git push --tags origin``.
|
||||
#. Upload the package to PyPI:
|
||||
|
||||
.. code:: console
|
||||
.. code:: bash
|
||||
|
||||
$ rm -rf dist/
|
||||
$ python setup.py sdist bdist_wheel
|
||||
$ twine upload --sign --identity security@readthedocs.org dist/*
|
||||
|
||||
#. Finally, open a new pull request updating the development release version to
|
||||
the next patch by running ``bump2version patch``. Open a pull request with
|
||||
this change. See `Versioning`_ above for more details.
|
||||
|
||||
.. _PEP440: https://www.python.org/dev/peps/pep-0440/
|
||||
.. _semantic versioning: http://semver.org/
|
||||
$ rm -rf dist/
|
||||
$ python setup.py sdist bdist_wheel
|
||||
$ twine upload --sign --identity security@readthedocs.org dist/*
|
||||
+5
-104
@@ -1,105 +1,19 @@
|
||||
***************************************
|
||||
API documentation and generated content
|
||||
***************************************
|
||||
|
||||
*********************
|
||||
:mod:`test_py_module`
|
||||
*********************
|
||||
|
||||
.. contents:: Table of Contents
|
||||
|
||||
:mod:`test_py_module`
|
||||
=====================
|
||||
|
||||
.. automodule:: test_py_module.test
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
C++ API
|
||||
=======
|
||||
|
||||
.. cpp:type:: MyType
|
||||
|
||||
Some type
|
||||
|
||||
.. cpp:function:: const MyType Foo(const MyType bar)
|
||||
|
||||
Some function type thing
|
||||
|
||||
.. cpp:class:: template<typename T, std::size_t N> std::array
|
||||
|
||||
Some cpp class
|
||||
|
||||
.. cpp:member:: float Sphinx::version
|
||||
|
||||
The description of Sphinx::version.
|
||||
|
||||
.. cpp:var:: int version
|
||||
|
||||
The description of version.
|
||||
|
||||
.. cpp:type:: std::vector<int> List
|
||||
|
||||
The description of List type.
|
||||
|
||||
.. cpp:enum:: MyEnum
|
||||
|
||||
An unscoped enum.
|
||||
|
||||
.. cpp:enumerator:: A
|
||||
|
||||
.. cpp:enum-class:: MyScopedEnum
|
||||
|
||||
A scoped enum.
|
||||
|
||||
.. cpp:enumerator:: B
|
||||
|
||||
.. cpp:enum-struct:: protected MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type
|
||||
|
||||
A scoped enum with non-default visibility, and with a specified underlying type.
|
||||
|
||||
.. cpp:enumerator:: B
|
||||
|
||||
|
||||
JavaScript API
|
||||
==============
|
||||
|
||||
.. Copied from sphinx-doc/sphinx/tests/roots
|
||||
|
||||
.. js:module:: module_a.submodule
|
||||
|
||||
* Link to :js:class:`ModTopLevel`
|
||||
|
||||
.. js:class:: ModTopLevel
|
||||
|
||||
* Link to :js:meth:`mod_child_1`
|
||||
* Link to :js:meth:`ModTopLevel.mod_child_1`
|
||||
|
||||
.. js:method:: ModTopLevel.mod_child_1
|
||||
|
||||
* Link to :js:meth:`mod_child_2`
|
||||
|
||||
.. js:method:: ModTopLevel.mod_child_2
|
||||
|
||||
* Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1`
|
||||
|
||||
.. js:module:: module_b.submodule
|
||||
|
||||
* Link to :js:class:`ModTopLevel`
|
||||
|
||||
.. js:class:: ModNested
|
||||
|
||||
.. js:method:: nested_child_1
|
||||
|
||||
* Link to :js:meth:`nested_child_2`
|
||||
|
||||
.. js:method:: nested_child_2
|
||||
|
||||
* Link to :js:meth:`nested_child_1`
|
||||
|
||||
|
||||
Generated Index
|
||||
===============
|
||||
|
||||
Part of the sphinx build process is to generate an index file: :ref:`genindex`.
|
||||
Part of the sphinx build process in generate and index file: :ref:`genindex`.
|
||||
|
||||
|
||||
Optional parameter args
|
||||
@@ -137,16 +51,3 @@ Data
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce congue elit eu hendrerit mattis.
|
||||
|
||||
Some data link :data:`Data_item_1`.
|
||||
|
||||
|
||||
Sphinx Extensions
|
||||
=================
|
||||
|
||||
sphinx.ext.autosummary
|
||||
----------------------
|
||||
|
||||
.. autosummary::
|
||||
|
||||
test_py_module.test.add_numbers
|
||||
test_py_module.test.subtract_numbers
|
||||
test_py_module.test.Foo
|
||||
+9
-11
@@ -25,18 +25,18 @@ citation references ([12]_), substitution references (|example|), and _`inline h
|
||||
text (generated by processing errors; this one is intentional).
|
||||
|
||||
Also with ``sphinx.ext.autodoc``, which I use in the demo, I can link to :class:`test_py_module.test.Foo`.
|
||||
It will link you right to my code documentation for it.
|
||||
It will link you right my code documentation for it.
|
||||
|
||||
The default role for [1]_ interpreted text is `Title Reference`. Here are some explicit interpreted text roles:
|
||||
The default role for interpreted text is `Title Reference`. Here are some explicit interpreted text roles:
|
||||
a PEP reference (:PEP:`287`); an RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;
|
||||
and explicit roles for :emphasis:`standard` :strong:`inline` :literal:`markup`.
|
||||
|
||||
GUI labels are a useful way to indicate that :guilabel:`Some action` is to be taken by the user.
|
||||
The GUI label should not run over ``line-height`` so as not to :guilabel:`interfere` with text from adjacent lines.
|
||||
|
||||
Key-bindings indicate that [1]_ the read is to press a button on the keyboard or mouse,
|
||||
Key-bindings indicate that the read is to press a button on the keyboard or mouse,
|
||||
for example :kbd:`MMB` and :kbd:`Shift-MMB`. Another useful markup to indicate a user action
|
||||
is to use ``menuselection`` this [1]_ can [1]_ be [1]_ used [1]_ to [1]_ show [1]_ short [1]_ and long menus in software.
|
||||
is to use ``menuselection`` this can be used to show short and long menus in software.
|
||||
For example, and ``menuselection`` can be seen here that breaks is too long to fit on this line.
|
||||
:menuselection:`My --> Software --> Some menu --> Some sub menu 1 --> sub menu 2`.
|
||||
|
||||
@@ -51,10 +51,6 @@ should be grouped in pairs).``
|
||||
|
||||
If the ``--pep-references`` option was supplied, there should be a live link to PEP 258 here.
|
||||
|
||||
.. regression test for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193
|
||||
|
||||
Very long URLs should be wrapped so lines do not overflow and cause horizontal scrolling: https://www.google.com/search?hl=en&q=very%20long%20url%20example%20of%20a%20url%20that%20is%20extremely%20long%20you%20probably%20want%20to%20avoid%20it%20but%20here%20we%20are
|
||||
|
||||
Math
|
||||
====
|
||||
|
||||
@@ -268,7 +264,7 @@ Footnotes
|
||||
Citations
|
||||
---------
|
||||
|
||||
.. [Citation] This is the citation I made, let's make this extremely long so that we can tell that it doesn't follow the normal responsive table stuff.
|
||||
.. [11] This is the citation I made, let's make this extremely long so that we can tell that it doesn't follow the normal responsive table stuff.
|
||||
|
||||
.. [12] This citation has some ``code blocks`` in it, maybe some **bold** and
|
||||
*italics* too. Heck, lets put a link to a meta citation [13]_ too.
|
||||
@@ -276,7 +272,9 @@ Citations
|
||||
.. [13] This citation will have two backlinks.
|
||||
|
||||
|
||||
Here's a reference to the above, [Citation]_, and a [nonexistent]_ citation.
|
||||
Here's a reference to the above, [12]_, and a [nonexistent]_ citation.
|
||||
|
||||
Here is another type of citation: `citation`
|
||||
|
||||
Glossary
|
||||
--------
|
||||
@@ -304,7 +302,7 @@ A reference can be found under `Inline Markup`_, above. `Inline
|
||||
hyperlink targets`_ are also possible.
|
||||
|
||||
Section headers are implicit targets, referred to by name. See
|
||||
Targets_, which is a subsection of `References`_.
|
||||
Targets_, which is a subsection of `Body Elements`_.
|
||||
|
||||
Explicit external targets are interpolated into references such as "Python_".
|
||||
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
|
||||
******************
|
||||
Breadcrumb Level 1
|
||||
******************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
level2/index.rst
|
||||
@@ -1,9 +0,0 @@
|
||||
|
||||
******************************************
|
||||
:mod:`Breadcrumb Level 2 <test_py_module>`
|
||||
******************************************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
level3/index.rst
|
||||
@@ -1,9 +0,0 @@
|
||||
|
||||
******************
|
||||
Breadcrumb Level 3
|
||||
******************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
level4/index.rst
|
||||
@@ -1,9 +0,0 @@
|
||||
|
||||
******************
|
||||
Breadcrumb Level 4
|
||||
******************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
level5/index.rst
|
||||
@@ -1,9 +0,0 @@
|
||||
|
||||
******************
|
||||
Breadcrumb Level 5
|
||||
******************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
level6/index.rst
|
||||
@@ -1,4 +0,0 @@
|
||||
|
||||
******************
|
||||
Breadcrumb Level 6
|
||||
******************
|
||||
@@ -49,18 +49,6 @@ Term : classifier
|
||||
Term
|
||||
Definition
|
||||
|
||||
I have no clue why the definition list below is classified as a different style
|
||||
of definition list than the one above.
|
||||
|
||||
Is it the spaces in the term?
|
||||
Maybe it was the multiple line paragraph
|
||||
in the line below that caused this?
|
||||
|
||||
Is it the paragraph above the list maybe?
|
||||
I guess a lot of these lists don't have leading paragraphs?
|
||||
|
||||
Is it everything all at once?
|
||||
Who knows?!
|
||||
|
||||
Option Lists
|
||||
------------
|
||||
@@ -130,28 +118,6 @@ Field list
|
||||
Bullet Lists
|
||||
------------
|
||||
|
||||
..
|
||||
Docutils supports two types of lists, "simple" and "complex". Complex lists
|
||||
have item margins, simple lists do not.
|
||||
https://docutils.sourceforge.io/sandbox/html4strict/data/simple-lists.html
|
||||
|
||||
Simple
|
||||
^^^^^^
|
||||
|
||||
- A simple list.
|
||||
- There are no margins between list items.
|
||||
- Simple lists do not contain multiple paragraphs. That's a complex list.
|
||||
- In the case of a nested list
|
||||
|
||||
- There are no margins between elements
|
||||
|
||||
- Still no margins
|
||||
|
||||
- Still no margins
|
||||
|
||||
Complex
|
||||
^^^^^^^
|
||||
|
||||
- A bullet list
|
||||
|
||||
+ Nested bullet list.
|
||||
@@ -172,13 +138,6 @@ Complex
|
||||
- ``inline literall``
|
||||
- ``inline literall``
|
||||
- ``inline literall``
|
||||
- This item has multiple paragraphs.
|
||||
|
||||
This item has multiple paragraphs.
|
||||
- This item has multiple paragraphs.
|
||||
|
||||
This item has multiple paragraphs.
|
||||
|
||||
|
||||
Second list level
|
||||
^^^^^^^^^^^^^^^^^
|
||||
@@ -191,7 +150,7 @@ Second list level
|
||||
- here is an inner bullet ``oh``
|
||||
|
||||
- one more ``with an inline literally``. `yahoo <http://www.yahoo.com>`_
|
||||
|
||||
|
||||
heh heh. child. try to beat this embed:
|
||||
|
||||
.. literalinclude:: test_py_module/test.py
|
||||
@@ -201,11 +160,6 @@ Second list level
|
||||
- and another. `yahoo <http://www.yahoo.com>`_
|
||||
- `yahoo <http://www.yahoo.com>`_
|
||||
- ``hi``
|
||||
- how about an admonition?
|
||||
|
||||
.. note::
|
||||
This is a note nested in a list.
|
||||
|
||||
- and hehe
|
||||
|
||||
But deeper down the rabbit hole
|
||||
@@ -346,26 +300,3 @@ List Tables
|
||||
|
||||
This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.
|
||||
|
||||
|
||||
Tables with paragraphs
|
||||
----------------------
|
||||
|
||||
.. regression test for https://github.com/readthedocs/sphinx_rtd_theme/issues/289
|
||||
|
||||
Test to see that tables behave well with nested paragraphs.
|
||||
|
||||
+------------+----------+-------------------------+
|
||||
| Precedence | Operator | Description |
|
||||
+============+==========+=========================+
|
||||
| 1 | \:: | Scope resolution |
|
||||
+------------+----------+-------------------------+
|
||||
| 2 | ( ) | Function call |
|
||||
| | | |
|
||||
| | [ ] | Subscript |
|
||||
| | | |
|
||||
| | . | Member access |
|
||||
| | | |
|
||||
| | .{ } | Bit-field concatenation |
|
||||
+------------+----------+-------------------------+
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 766 B |
@@ -12,20 +12,6 @@ class Foo:
|
||||
and etc, but those will *always* have the ``.descname`` or
|
||||
``.descclassname`` class.
|
||||
|
||||
Term
|
||||
It is also possible to include definitions inside docstrings.
|
||||
They should be styled as a normal definition list.
|
||||
|
||||
:Field List:
|
||||
It is also possible to include definitions inside docstrings.
|
||||
They should be styled as a normal definition list.
|
||||
|
||||
.. [1] A footnote contains body elements, consistently indented by at
|
||||
least 3 spaces.
|
||||
|
||||
.. [Citation] A citation contains body elements, consistently indented by at
|
||||
least 3 spaces.
|
||||
|
||||
Normal ``<tt>`` (like the <tt> I just wrote here) needs to be shown with
|
||||
the same style as anything else with ````this type of markup````.
|
||||
|
||||
@@ -79,7 +65,6 @@ class Foo:
|
||||
:type val2: int
|
||||
:rtype: int
|
||||
|
||||
The parameters of this method are described in the parameter list.
|
||||
"""
|
||||
|
||||
return val1 + val2
|
||||
@@ -126,23 +111,3 @@ class Foo:
|
||||
This is deprecated since 3.0
|
||||
"""
|
||||
return sum(kwargs.values()) / len(kwargs), a + b
|
||||
|
||||
|
||||
def add_numbers(a: int, b: int = 0) -> int:
|
||||
"""Add two numbers together
|
||||
|
||||
:param a: The first number
|
||||
:param b: The second number
|
||||
|
||||
Here is some more text.
|
||||
"""
|
||||
return a + b
|
||||
|
||||
|
||||
def subtract_numbers(a: int, b: int = 0) -> int:
|
||||
"""Subtract two numbers
|
||||
|
||||
:param a: The first number
|
||||
:param b: The second number
|
||||
"""
|
||||
return a - b
|
||||
@@ -1,207 +0,0 @@
|
||||
Development
|
||||
===========
|
||||
|
||||
The theme developers follow the guidelines below for development and release
|
||||
planning. Documentation authors can decide which theme release works best for
|
||||
their project based on required browser/operating system combinations or
|
||||
dependency support.
|
||||
|
||||
.. _supported-browsers:
|
||||
|
||||
Supported browsers
|
||||
------------------
|
||||
|
||||
Official browser support is determined by the most popular browser/operating
|
||||
system combinations in our pageview analytics. Officially supported combinations
|
||||
are commonly tested during development, and are always tested before final
|
||||
release of a new version of the theme.
|
||||
|
||||
Older releases of supported combinations, and some less common combinations, are
|
||||
considered partially supported. This means that we do not consistently test
|
||||
these combinations, however we do expect user experience to be comparable with
|
||||
supported combinations.
|
||||
|
||||
.. csv-table:: Supported browser combinations
|
||||
:widths: 6, 12, 4
|
||||
:header-rows: 1
|
||||
:file: supported-browsers.csv
|
||||
|
||||
.. versionadded:: 1.0
|
||||
Supported browser and operating system combinations added
|
||||
|
||||
There are several browser/operating system combinations that are not supported
|
||||
by the theme developers at all. Unsupported combinations do not receive testing
|
||||
or development, and we likely won't accept major contributions for these
|
||||
combinations.
|
||||
|
||||
Unsupported browser/operating system combinations include:
|
||||
|
||||
Internet Explorer (any OS, any version)
|
||||
Support was removed in the :ref:`roadmap-release-3.0.0` release.
|
||||
|
||||
Opera (any OS, any version)
|
||||
**Community support only.** We do not receive enough traffic with this
|
||||
browser to officially support it in testing and development.
|
||||
|
||||
.. _supported-dependencies:
|
||||
|
||||
Supported dependencies
|
||||
----------------------
|
||||
|
||||
The theme officially supports the following dependencies in your Sphinx project:
|
||||
|
||||
.. list-table:: Supported dependencies
|
||||
:header-rows: 1
|
||||
:widths: 10, 10
|
||||
|
||||
* - Dependency
|
||||
- Versions
|
||||
* - Python
|
||||
- 3.8 or greater
|
||||
* - Sphinx
|
||||
- 6 or greater
|
||||
* - docutils
|
||||
- > 0.18, < 0.22
|
||||
|
||||
.. deprecated:: 3.0
|
||||
Sphinx < 6 support removed
|
||||
|
||||
.. deprecated:: 2.0
|
||||
Sphinx < 5 support removed
|
||||
|
||||
.. deprecated:: 2.0
|
||||
Python < 3.6 support removed
|
||||
|
||||
.. deprecated:: 2.0
|
||||
docutils < 0.14 support removed
|
||||
|
||||
.. versionadded:: 1.0
|
||||
Sphinx 4.0 support added
|
||||
|
||||
.. deprecated:: 1.0
|
||||
Sphinx 1.6 support removed
|
||||
|
||||
.. versionadded:: 1.0
|
||||
docutils 0.17 support added
|
||||
|
||||
Roadmap
|
||||
-------
|
||||
|
||||
We currently have several releases planned on our development roadmap. Backward
|
||||
incompatible changes, deprecations, and major features are noted for each of
|
||||
these releases.
|
||||
|
||||
Releases follow `semantic versioning`_, and so it is generally recommended that
|
||||
authors pin dependency on ``sphinx_rtd_theme`` to a version below the next major
|
||||
version:
|
||||
|
||||
.. code:: console
|
||||
|
||||
$ pip install "sphinx_rtd_theme<2.0.0"
|
||||
|
||||
.. _semantic versioning: http://semver.org/
|
||||
|
||||
.. _roadmap-release-1.0.0:
|
||||
|
||||
1.0.0
|
||||
~~~~~
|
||||
|
||||
:Planned release date: August 2021
|
||||
|
||||
This release will be a slightly backwards incompatible release to follow the
|
||||
:ref:`release-0.5.2` release. It will drop support for Sphinx 1.6, which is a rather old
|
||||
release at this point.
|
||||
|
||||
This version will add official support for the Sphinx 4.x release series and
|
||||
it resolves bugs with the latest release of Docutils, version 0.17.
|
||||
|
||||
Starting with this release, several deprecation warnings will be emitted at
|
||||
build time:
|
||||
|
||||
Direct installation is deprecated
|
||||
Support for direct installation through GitHub is no longer a suggested
|
||||
installation method. In an effort to ease maintenance, compiled assets will
|
||||
eventually be removed from the theme repository. These files will only be
|
||||
included in the built packages/releases available on PyPI.
|
||||
|
||||
We plan to start putting development releases up on PyPI more frequently, so
|
||||
that installation from the theme source repository is no longer necessary.
|
||||
|
||||
Built assets are tentatively planned to be removed in version :ref:`roadmap-release-3.0.0`:.
|
||||
|
||||
HTML4 support is deprecated
|
||||
Support for the Sphinx HTML4 writer will be removed in the :ref:`roadmap-release-2.0.0`
|
||||
release.
|
||||
|
||||
.. _roadmap-release-1.1.0:
|
||||
|
||||
1.1.0
|
||||
~~~~~
|
||||
|
||||
:Planned release date: 2021 Q3
|
||||
|
||||
We aim to follow up release :ref:`release-1.0.0` with at least one bug fix release in
|
||||
the 1.x release series. The 1.1 release will not be adding any major features
|
||||
and will instead mark the last release targeting projects with old dependencies
|
||||
like Sphinx 1.8, HTML4, or required support for IE11.
|
||||
|
||||
.. _roadmap-release-2.0.0:
|
||||
|
||||
2.0.0
|
||||
~~~~~
|
||||
|
||||
:Planned release date: 2023 Q3
|
||||
|
||||
This release will drop support for old Python and Sphinx versions.
|
||||
|
||||
Note the following backwards incompatible changes are planned for this
|
||||
release:
|
||||
|
||||
Python < 3.6, Sphinx < 5 and Docutils < 0.14 will not be tested
|
||||
Official support will drop for these version, though they may still continue
|
||||
to work. Theme developers will not be testing these versions any longer.
|
||||
|
||||
HTML4 support will be removed
|
||||
Starting with this release, we will only support the HTML5 writer output,
|
||||
and builds attempting to use the HTML4 writer will fail. If you are still
|
||||
using the HTML4 writer, or have the ``html4_writer = True`` option in your
|
||||
Sphinx configuration file, you will need to either remove this option or pin
|
||||
your dependency to ``sphinx_rtd_theme<=3`` until you can.
|
||||
|
||||
This option was suggested in the past to work around issues with HTML5
|
||||
support and should no longer be required to use a modern combination of this
|
||||
theme and Sphinx.
|
||||
|
||||
.. _roadmap-release-3.0.0:
|
||||
|
||||
3.0.0
|
||||
~~~~~
|
||||
|
||||
:Planned release date: 2024 Q3
|
||||
|
||||
This release will drop support for old Python and Sphinx versions,
|
||||
and will add support for new ones.
|
||||
|
||||
Sphinx 5, Python < 3.8 and docutils < 0.18 support will be removed
|
||||
Sphinx 5 is the latest version that supports Python 3.6 and 3.7,
|
||||
and docutils < 0.18.
|
||||
|
||||
Internet Explorer 11 support will be dropped
|
||||
`IE11 reached end of life on 14 June 20222 <https://endoflife.date/internet-explorer>`_,
|
||||
so we are not supporting it on newer versions,
|
||||
starting on 3.0.0.
|
||||
|
||||
.. _roadmap-release-4.0.0:
|
||||
|
||||
4.0.0
|
||||
~~~~~
|
||||
|
||||
:Planned release date: 2024 Q2
|
||||
|
||||
This release is not yet planned.
|
||||
There are plans to potentially replace Wyrm with Bootstrap in a release after 3.0.
|
||||
|
||||
Also tentatively planned for this release is finally removing built CSS and
|
||||
JavaScript assets from our repository. This will remove the ability to install
|
||||
the package directly from GitHub, and instead users will be advised to install
|
||||
development releases from PyPI.
|
||||
+3
-65
@@ -1,74 +1,19 @@
|
||||
Read the Docs Sphinx Theme
|
||||
==========================
|
||||
|
||||
This Sphinx_ theme was designed to provide a great reader experience for
|
||||
documentation users on both desktop and mobile devices. This theme is commonly
|
||||
used with projects on `Read the Docs`_ but can work with any Sphinx project.
|
||||
|
||||
.. _Sphinx: http://www.sphinx-doc.org
|
||||
.. _Read the Docs: http://www.readthedocs.org
|
||||
|
||||
Using this theme
|
||||
----------------
|
||||
|
||||
:doc:`installing`
|
||||
How to install this theme on your Sphinx project.
|
||||
|
||||
:doc:`configuring`
|
||||
Theme configuration and customization options.
|
||||
|
||||
:ref:`supported-browsers`
|
||||
Supported browser/operating system combinations.
|
||||
|
||||
:ref:`supported-dependencies`
|
||||
Supported project dependencies, like Python and Sphinx.
|
||||
|
||||
Development
|
||||
-----------
|
||||
|
||||
:doc:`contributing`
|
||||
How to contribute changes to the theme.
|
||||
|
||||
:doc:`Development guidelines <development>`
|
||||
Guidelines the theme developers use for developing and testing changes.
|
||||
|
||||
`Read the Docs contributor guide`_
|
||||
Our contribution guidelines extend to all projects maintained by Read the
|
||||
Docs core team.
|
||||
|
||||
:doc:`changelog`
|
||||
The theme development changelog.
|
||||
|
||||
:doc:`Demo documentation <demo/structure>`
|
||||
The theme's styleguide test environment, where new changes are tested.
|
||||
|
||||
|
||||
.. _Read the Docs contributor guide: https://docs.readthedocs.io/en/stable/contribute.html
|
||||
|
||||
|
||||
.. Hidden TOCs
|
||||
.. include:: ../README.rst
|
||||
|
||||
.. toctree::
|
||||
:caption: Theme Documentation
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
installing
|
||||
configuring
|
||||
development
|
||||
changelog
|
||||
contributing
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
changelog
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:numbered:
|
||||
:caption: Demo Documentation
|
||||
:hidden:
|
||||
:caption: Demo Documents
|
||||
|
||||
demo/structure
|
||||
demo/demo
|
||||
@@ -79,12 +24,5 @@ Development
|
||||
:maxdepth: 3
|
||||
:numbered:
|
||||
:caption: This is an incredibly long caption for a long menu
|
||||
:hidden:
|
||||
|
||||
demo/long
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Breadcrumbs
|
||||
|
||||
demo/level1/index.rst
|
||||
+18
-44
@@ -1,58 +1,32 @@
|
||||
|
||||
************
|
||||
Installation
|
||||
============
|
||||
************
|
||||
|
||||
How to install and use the theme
|
||||
--------------------------------
|
||||
Via Python Package
|
||||
==================
|
||||
|
||||
Install the ``sphinx_rtd_theme`` package (or add it to your ``requirements.txt`` file):
|
||||
Install the package (or add it to your ``requirements.txt`` file):
|
||||
|
||||
.. code:: console
|
||||
.. code:: bash
|
||||
|
||||
$ pip install sphinx_rtd_theme
|
||||
pip install sphinx_rtd_theme
|
||||
|
||||
In your Sphinx project's ``conf.py`` file, add ``sphinx_rtd_theme`` to the list of enabled extensions and as the active theme:
|
||||
In your ``conf.py`` file:
|
||||
|
||||
.. code:: python
|
||||
|
||||
extensions = [
|
||||
...
|
||||
'sphinx_rtd_theme',
|
||||
]
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
.. seealso::
|
||||
:ref:`supported-browsers`
|
||||
Officially supported and tested browser/operating system combinations
|
||||
Via Git or Download
|
||||
===================
|
||||
|
||||
:ref:`supported-dependencies`
|
||||
Officially Supported versions of Python, Sphinx, and other dependencies.
|
||||
Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
|
||||
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
|
||||
``conf.py`` file:
|
||||
|
||||
.. code:: python
|
||||
|
||||
.. note::
|
||||
|
||||
Adding this theme as an extension activates the ``sphinxcontrib-jquery`` extension,
|
||||
which is required for search, smooth scrolling, and the flyout menu.
|
||||
If any of these features don't work, make sure you have the theme declared in your ``extensions``.
|
||||
|
||||
.. More context for this note:
|
||||
* https://github.com/readthedocs/sphinx_rtd_theme/issues/1434#issuecomment-2288359582
|
||||
* https://github.com/readthedocs/sphinx_rtd_theme/issues/1222#issuecomment-2296703160
|
||||
|
||||
|
||||
.. _howto_upgrade:
|
||||
|
||||
How to upgrade
|
||||
--------------
|
||||
|
||||
Adding ``sphinx-rtd-theme`` to your project's dependencies will make pip install the latest compatible version of the theme.
|
||||
|
||||
If you want to test a **pre-release**, you need to be explicit about the version you specify.
|
||||
Otherwise, pip will ignore pre-releases. Add for instance ``sphinx-rtd-theme==1.1.0b3`` to test a pre-release.
|
||||
|
||||
.. tip::
|
||||
We recommend that you pin the version of Sphinx that your project is built with.
|
||||
We won't release sphinx-rtd-theme without marking its compatibility with Sphinx. So if you do not pin ``sphinx-rtd-theme`` itself, you will always get the *latest compatible* release.
|
||||
|
||||
More information is available in Read the Docs' documentation on :doc:`rtd:guides/reproducible-builds`.
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_path = ["_themes", ]
|
||||
|
||||
@@ -1 +1,2 @@
|
||||
sphinx>=7.1,<7.2
|
||||
sphinxcontrib-httpdomain
|
||||
sphinx
|
||||
@@ -1,5 +0,0 @@
|
||||
Browser,Operating System,Versions
|
||||
Chrome,"Windows, MacOS, Linux, Android",>=90
|
||||
Firefox,"Linux, Windows",>=90
|
||||
Edge,Windows,>=90
|
||||
Safari,"MacOS, iOS",>=13
|
||||
|
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
@@ -1,4 +1,3 @@
|
||||
// jQuery is included via the sphinxcontrib-jquery extension that we depend on
|
||||
var jQuery = (typeof(window) != 'undefined') ? window.jQuery : require('jquery');
|
||||
|
||||
// Sphinx theme nav state
|
||||
@@ -67,7 +66,11 @@ function ThemeNav () {
|
||||
// TODO remove this with a split in theme and Read the Docs JS logic as
|
||||
// well, it's only here to support 0.3.0 installs of our theme.
|
||||
nav.enableSticky = function() {
|
||||
{%- if theme_sticky_navigation|tobool %}
|
||||
this.enable(true);
|
||||
{%- else %}
|
||||
this.enable(false);
|
||||
{%- endif %}
|
||||
};
|
||||
|
||||
nav.init = function ($) {
|
||||
@@ -113,8 +116,7 @@ function ThemeNav () {
|
||||
// Add expand links to all parents of nested ul
|
||||
$('.wy-menu-vertical ul').not('.simple').siblings('a').each(function () {
|
||||
var link = $(this);
|
||||
expand =
|
||||
$('<button class="toctree-expand" title="Open/close menu"></button>');
|
||||
expand = $('<span class="toctree-expand"></span>');
|
||||
expand.on('click', function (ev) {
|
||||
self.toggleCurrent(link);
|
||||
ev.stopPropagation();
|
||||
@@ -146,20 +148,14 @@ function ThemeNav () {
|
||||
// If we found a matching link then reset current and re-apply
|
||||
// otherwise retain the existing match
|
||||
if (link.length > 0) {
|
||||
$('.wy-menu-vertical .current')
|
||||
.removeClass('current')
|
||||
.attr('aria-expanded','false');
|
||||
link.addClass('current')
|
||||
.attr('aria-expanded','true');
|
||||
link.closest('li.toctree-l1')
|
||||
.parent()
|
||||
.addClass('current')
|
||||
.attr('aria-expanded','true');
|
||||
for (let i = 1; i <= 10; i++) {
|
||||
link.closest('li.toctree-l' + i)
|
||||
.addClass('current')
|
||||
.attr('aria-expanded','true');
|
||||
}
|
||||
$('.wy-menu-vertical .current').removeClass('current');
|
||||
link.addClass('current');
|
||||
link.closest('li.toctree-l1').addClass('current');
|
||||
link.closest('li.toctree-l1').parent().addClass('current');
|
||||
link.closest('li.toctree-l1').addClass('current');
|
||||
link.closest('li.toctree-l2').addClass('current');
|
||||
link.closest('li.toctree-l3').addClass('current');
|
||||
link.closest('li.toctree-l4').addClass('current');
|
||||
link[0].scrollIntoView();
|
||||
}
|
||||
}
|
||||
@@ -197,27 +193,10 @@ function ThemeNav () {
|
||||
|
||||
nav.toggleCurrent = function (elem) {
|
||||
var parent_li = elem.closest('li');
|
||||
parent_li
|
||||
.siblings('li.current')
|
||||
.removeClass('current')
|
||||
.attr('aria-expanded','false');
|
||||
parent_li
|
||||
.siblings()
|
||||
.find('li.current')
|
||||
.removeClass('current')
|
||||
.attr('aria-expanded','false');
|
||||
var children = parent_li.find('> ul li');
|
||||
// Don't toggle terminal elements.
|
||||
if (children.length) {
|
||||
children
|
||||
.removeClass('current')
|
||||
.attr('aria-expanded','false');
|
||||
parent_li
|
||||
.toggleClass('current')
|
||||
.attr('aria-expanded', function(i, old) {
|
||||
return old == 'true' ? 'false' : 'true';
|
||||
});
|
||||
}
|
||||
parent_li.siblings('li.current').removeClass('current');
|
||||
parent_li.siblings().find('li.current').removeClass('current');
|
||||
parent_li.find('> ul li.current').removeClass('current');
|
||||
parent_li.toggleClass('current');
|
||||
}
|
||||
|
||||
return nav;
|
||||
@@ -264,3 +243,15 @@ if (typeof(window) != 'undefined') {
|
||||
clearTimeout(id);
|
||||
};
|
||||
}());
|
||||
|
||||
{# Do not conflict with RTD insertion of analytics script #}
|
||||
{%- if not READTHEDOCS %}
|
||||
{%- if theme_analytics_id %}
|
||||
window.addEventListener("load", function(){
|
||||
ga('create', '{{ theme_analytics_id }}', 'auto');
|
||||
ga('send', 'pageview');
|
||||
})
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
|
||||
Generated
-8337
File diff suppressed because it is too large.
Load diff
+17
-37
@@ -1,43 +1,23 @@
|
||||
{
|
||||
"name": "sphinx_rtd_theme",
|
||||
"main": "js/theme.js",
|
||||
"version": "3.0.0rc2",
|
||||
"scripts": {
|
||||
"dev": "webpack-dev-server --open --config webpack.dev.js",
|
||||
"build": "webpack --config webpack.prod.js",
|
||||
"preinstall": "bin/preinstall.js"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/readthedocs/sphinx_rtd_theme.git"
|
||||
},
|
||||
"author": "Read the Docs",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/readthedocs/sphinx_rtd_theme/issues"
|
||||
},
|
||||
"homepage": "https://github.com/readthedocs/sphinx_rtd_theme",
|
||||
"version": "0.4.3",
|
||||
"private": true,
|
||||
"devDependencies": {
|
||||
"bourbon": "~4.3",
|
||||
"bourbon-neat": "~1.9",
|
||||
"css-loader": "^3.6.0",
|
||||
"file-loader": "^3.0.1",
|
||||
"font-awesome": "^4.7.0",
|
||||
"imports-loader": "^0.8.0",
|
||||
"jquery": "^3.6.0",
|
||||
"lato-font": "^3.0.0",
|
||||
"mini-css-extract-plugin": "^0.6.0",
|
||||
"node-sass": "^4.14.1",
|
||||
"optimize-css-assets-webpack-plugin": "^5.0.4",
|
||||
"roboto-fontface": "^0.10.0",
|
||||
"sass-loader": "^7.3.0",
|
||||
"style-loader": "^0.23.1",
|
||||
"webpack": "^4.46.0",
|
||||
"webpack-cli": "^3.3.12",
|
||||
"webpack-dev-server": "^3.11.2",
|
||||
"webpack-merge": "^4.2.1",
|
||||
"webpack-shell-plugin": "^0.5.0",
|
||||
"webpack-watch-files-plugin": "^1.1.0",
|
||||
"wyrm": "^1.0.9"
|
||||
"bower": "^1.8.4",
|
||||
"browserify": "^13.0.0",
|
||||
"connect-livereload": "~0.6.0",
|
||||
"grunt": "~1.0.1",
|
||||
"grunt-banner": "^0.6.0",
|
||||
"grunt-browserify": "^5.0.0",
|
||||
"grunt-contrib-clean": "^1.0.0",
|
||||
"grunt-contrib-connect": "^1.0.2",
|
||||
"grunt-contrib-copy": "~1.0.0",
|
||||
"grunt-contrib-sass": "~1.0.0",
|
||||
"grunt-contrib-uglify": "~3.3.0",
|
||||
"grunt-contrib-watch": "~1.0.0",
|
||||
"grunt-exec": "~1.0.1",
|
||||
"grunt-open": "0.2.3",
|
||||
"matchdep": "~1.0.1"
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
[pytest]
|
||||
filterwarnings =
|
||||
# Ignore external dependencies warning deprecations
|
||||
# Sphinx
|
||||
# ignore::sphinx.deprecation.RemovedInSphinx90Warning
|
||||
@@ -58,8 +58,6 @@
|
||||
display: inline-block
|
||||
padding: $base-line-height / 4
|
||||
color: $section-background-color
|
||||
.rtd-current-item
|
||||
font-weight: bold
|
||||
&.rst-badge
|
||||
width: auto
|
||||
bottom: 20px
|
||||
@@ -70,17 +68,15 @@
|
||||
max-height: 90%
|
||||
.icon-book
|
||||
float: none
|
||||
line-height: 30px
|
||||
.fa-book
|
||||
float: none
|
||||
line-height: 30px
|
||||
&.shift-up .rst-current-version
|
||||
text-align: right
|
||||
.fa-book
|
||||
float: left
|
||||
.icon-book
|
||||
float: left
|
||||
> .rst-current-version
|
||||
.rst-current-version
|
||||
width: auto
|
||||
height: 30px
|
||||
line-height: 30px
|
||||
@@ -94,6 +90,3 @@
|
||||
display: none
|
||||
&.shift
|
||||
display: block
|
||||
|
||||
#flyout-search-form
|
||||
padding: 6px
|
||||
@@ -1,6 +1,6 @@
|
||||
// Slimmer version of FA for use on the badge_only.sass file.
|
||||
|
||||
+font-face(FontAwesome, '#{$fa-font-path}/fontawesome-webfont')
|
||||
+font-face(FontAwesome, '#{$font-awesome-dir}fontawesome-webfont')
|
||||
|
||||
.fa:before
|
||||
display: inline-block
|
||||
@@ -9,6 +9,7 @@
|
||||
font-weight: normal
|
||||
line-height: 1
|
||||
text-decoration: inherit
|
||||
+font-smooth
|
||||
|
||||
a .fa
|
||||
display: inline-block
|
||||
@@ -29,7 +30,7 @@ ul.fas
|
||||
text-indent: -0.8em
|
||||
li
|
||||
.fa
|
||||
width: 0.8em
|
||||
width: .8em
|
||||
.fa-large:before,
|
||||
.fa-large:before
|
||||
/* 1.5 increased font size for fa-large * 1.25 width
|
||||
@@ -1,22 +1,21 @@
|
||||
.wy-breadcrumbs
|
||||
+clearfix
|
||||
|
||||
.wy-breadcrumbs > li
|
||||
.wy-breadcrumbs li
|
||||
display: inline-block
|
||||
padding-top: 5px
|
||||
&.wy-breadcrumbs-aside
|
||||
float: right
|
||||
/* Style literals as links */
|
||||
a
|
||||
display: inline-block
|
||||
padding: 5px
|
||||
&:first-child
|
||||
padding-left: 0
|
||||
code
|
||||
all: inherit
|
||||
color: inherit
|
||||
|
||||
.breadcrumb-item::before
|
||||
content: "/"
|
||||
color: #bbb
|
||||
font-size: 13px
|
||||
padding: 0 6px 0 3px
|
||||
|
||||
padding: 5px
|
||||
border: none
|
||||
background: none
|
||||
&.literal
|
||||
color: $text-color
|
||||
.wy-breadcrumbs-extra
|
||||
margin-bottom: 0
|
||||
color: $text-light
|
||||
File renamed without changes.
@@ -0,0 +1,42 @@
|
||||
@font-face
|
||||
font-family: 'Lato'
|
||||
src: url('../fonts/Lato/lato-regular.eot')
|
||||
src: url('../fonts/Lato/lato-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-regular.woff2') format('woff2'), url('../fonts/Lato/lato-regular.woff') format('woff'), url('../fonts/Lato/lato-regular.ttf') format('truetype')
|
||||
font-weight: 400
|
||||
font-style: normal
|
||||
|
||||
@font-face
|
||||
font-family: 'Lato'
|
||||
src: url('../fonts/Lato/lato-bold.eot')
|
||||
src: url('../fonts/Lato/lato-bold.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-bold.woff2') format('woff2'), url('../fonts/Lato/lato-bold.woff') format('woff'), url('../fonts/Lato/lato-bold.ttf') format('truetype')
|
||||
font-weight: 700
|
||||
font-style: normal
|
||||
|
||||
|
||||
@font-face
|
||||
font-family: 'Lato'
|
||||
src: url('../fonts/Lato/lato-bolditalic.eot')
|
||||
src: url('../fonts/Lato/lato-bolditalic.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-bolditalic.woff2') format('woff2'), url('../fonts/Lato/lato-bolditalic.woff') format('woff'), url('../fonts/Lato/lato-bolditalic.ttf') format('truetype')
|
||||
font-weight: 700
|
||||
font-style: italic
|
||||
|
||||
@font-face
|
||||
font-family: 'Lato'
|
||||
src: url('../fonts/Lato/lato-italic.eot')
|
||||
src: url('../fonts/Lato/lato-italic.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-italic.woff2') format('woff2'), url('../fonts/Lato/lato-italic.woff') format('woff'), url('../fonts/Lato/lato-italic.ttf') format('truetype')
|
||||
font-weight: 400
|
||||
font-style: italic
|
||||
|
||||
@font-face
|
||||
font-family: 'Roboto Slab'
|
||||
font-style: normal
|
||||
font-weight: 400
|
||||
src: url('../fonts/RobotoSlab/roboto-slab.eot')
|
||||
src: url('../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.woff2') format('woff2'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.woff') format('woff'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.ttf') format('truetype')
|
||||
|
||||
@font-face
|
||||
font-family: 'Roboto Slab'
|
||||
font-style: normal
|
||||
font-weight: 700
|
||||
src: url('../fonts/RobotoSlab/roboto-slab-v7-bold.eot')
|
||||
src: url('../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix') format('embedded-opentype'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.woff2') format('woff2'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.woff') format('woff'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.ttf') format('truetype')
|
||||
@@ -15,7 +15,7 @@ html
|
||||
ul, li
|
||||
display: inline-block
|
||||
li:hover
|
||||
background: rgba(255, 255, 255, 0.1)
|
||||
background: rgba(255,255,255,.1)
|
||||
li
|
||||
&.divide-left
|
||||
border-left: solid 1px hsl(0, 0%, 25%)
|
||||
@@ -33,9 +33,10 @@ html
|
||||
header, p.caption
|
||||
color: $nav-caption
|
||||
height: $base-font-size * 2
|
||||
display: inline-block
|
||||
line-height: $base-font-size * 2
|
||||
padding: 0 $gutter
|
||||
margin: ($base-line-height / 2) 0 0 0
|
||||
margin: $base-line-height / 2 0 0 0
|
||||
display: block
|
||||
font-weight: bold
|
||||
text-transform: uppercase
|
||||
@@ -54,7 +55,7 @@ html
|
||||
a
|
||||
color: $menu-link-medium
|
||||
border-right: solid 1px darken($menu-vertical-background-color, 20%)
|
||||
padding: ($gutter / 4) ($gutter * 1.5)
|
||||
padding: $gutter / 4 $gutter * 1.5
|
||||
&:hover
|
||||
background: darken($menu-vertical-background-color, 15%)
|
||||
code
|
||||
@@ -64,36 +65,36 @@ html
|
||||
padding-left: 0
|
||||
padding-right: 0
|
||||
// Expand links
|
||||
button.toctree-expand
|
||||
span.toctree-expand
|
||||
display: block
|
||||
float: left
|
||||
margin-left: -1.2em
|
||||
@extend .fa
|
||||
@extend .fa-plus-square-o
|
||||
line-height: 18px
|
||||
font-size: .8em
|
||||
line-height: 1.6em
|
||||
color: darken($menu-link-medium, 20%)
|
||||
border: none
|
||||
background: none
|
||||
padding: 0
|
||||
|
||||
// On state for the first level
|
||||
li.on a, li.current > a
|
||||
color: $menu-link-color
|
||||
padding: ($gutter / 4) $gutter
|
||||
padding: $gutter / 4 $gutter
|
||||
font-weight: bold
|
||||
position: relative
|
||||
background: $menu-vertical-background-color
|
||||
border: none
|
||||
padding-left: $gutter -4px
|
||||
+font-smooth
|
||||
&:hover
|
||||
background: $menu-vertical-background-color
|
||||
button.toctree-expand
|
||||
span.toctree-expand
|
||||
color: $menu-link-medium
|
||||
button.toctree-expand
|
||||
span.toctree-expand
|
||||
@extend .fa
|
||||
@extend .fa-minus-square-o
|
||||
display: block
|
||||
line-height: 18px
|
||||
font-size: .8em
|
||||
line-height: 1.6em
|
||||
color: darken($menu-link-medium, 30%)
|
||||
|
||||
li.toctree-l1.current > a
|
||||
@@ -101,63 +102,42 @@ html
|
||||
border-top: solid 1px darken($menu-vertical-background-color, 20%)
|
||||
|
||||
// This is the on state for pages beyond second level
|
||||
|
||||
%hide_show_toctree_ul
|
||||
li.toctree-l2 a, li.toctree-l3 a, li.toctree-l4 a
|
||||
color: $menu-link-color
|
||||
li.toctree-l1.current li.toctree-l2, li.toctree-l2.current li.toctree-l3
|
||||
> ul
|
||||
display: none
|
||||
&.current > ul
|
||||
display: block
|
||||
|
||||
%shrink_toctree_element
|
||||
font-size: 0.9em
|
||||
|
||||
%toctree_link_color
|
||||
color: $menu-link-color
|
||||
|
||||
%toctree_hover_link_color
|
||||
color: $menu-link-medium
|
||||
|
||||
%display_current_toctree_element
|
||||
display: block
|
||||
|
||||
@for $toc_level from 1 through 10
|
||||
.toctree-l#{$toc_level}.current .toctree-l#{$toc_level + 1}
|
||||
@extend %hide_show_toctree_ul
|
||||
|
||||
@if $toc_level > 1
|
||||
li.toctree-l#{$toc_level}
|
||||
a
|
||||
@extend %toctree_link_color
|
||||
&.current
|
||||
> a
|
||||
padding: ($gutter / 4) ($gutter * ($toc_level - 1 + 0.5))
|
||||
|
||||
li.toctree-l#{$toc_level + 1} > a
|
||||
@extend %display_current_toctree_element
|
||||
padding: ($gutter / 4) ($gutter * ($toc_level + 0.5))
|
||||
padding-right: $gutter
|
||||
a:hover button.toctree-expand
|
||||
@extend %toctree_hover_link_color
|
||||
@if $toc_level > 2 and $toc_level < 5
|
||||
li.toctree-l#{$toc_level}
|
||||
@extend %shrink_toctree_element
|
||||
|
||||
li.toctree-l2
|
||||
&.current
|
||||
> a
|
||||
background: darken($menu-vertical-background-color, 20%)
|
||||
padding: $gutter / 4 $gutter * 1.5
|
||||
li.toctree-l3 > a
|
||||
display: block
|
||||
background: darken($menu-vertical-background-color, 20%)
|
||||
button.toctree-expand
|
||||
padding: $gutter / 4 $gutter * 2.5
|
||||
a:hover span.toctree-expand
|
||||
color: $menu-link-medium
|
||||
span.toctree-expand
|
||||
color: darken($menu-vertical-background-color, 35%)
|
||||
li.toctree-l3
|
||||
font-size: .9em
|
||||
&.current
|
||||
> a
|
||||
background: darken($menu-vertical-background-color, 25%)
|
||||
padding: $gutter / 4 $gutter * 2.5
|
||||
li.toctree-l4 > a
|
||||
display: block
|
||||
background: darken($menu-vertical-background-color, 25%)
|
||||
button.toctree-expand
|
||||
padding: $gutter / 4 $gutter * 3.5
|
||||
a:hover span.toctree-expand
|
||||
color: $menu-link-medium
|
||||
span.toctree-expand
|
||||
color: darken($menu-vertical-background-color, 40%)
|
||||
li.toctree-l4
|
||||
font-size: .9em
|
||||
|
||||
li.current ul
|
||||
display: block
|
||||
@@ -169,8 +149,9 @@ html
|
||||
color: $menu-link-light
|
||||
font-weight: normal
|
||||
a
|
||||
display: inline-block
|
||||
line-height: 18px
|
||||
padding: ($gutter / 4) $gutter
|
||||
padding: $gutter / 4 $gutter
|
||||
display: block
|
||||
position: relative
|
||||
font-size: 90%
|
||||
@@ -178,13 +159,13 @@ html
|
||||
&:hover
|
||||
background-color: lighten($menu-background-color, 10%)
|
||||
cursor: pointer
|
||||
button.toctree-expand
|
||||
span.toctree-expand
|
||||
color: $menu-link-light
|
||||
&:active
|
||||
background-color: $menu-logo-color
|
||||
cursor: pointer
|
||||
color: $menu-link-active
|
||||
button.toctree-expand
|
||||
span.toctree-expand
|
||||
color: $menu-link-active
|
||||
|
||||
.wy-side-nav-search
|
||||
@@ -195,7 +176,10 @@ html
|
||||
z-index: $z-index-popover
|
||||
background-color: $nav-search-background-color
|
||||
text-align: center
|
||||
padding: $gutter / 2
|
||||
display: block
|
||||
color: $nav-search-color
|
||||
margin-bottom: $gutter / 2
|
||||
input[type=text]
|
||||
width: 100%
|
||||
border-radius: 50px
|
||||
@@ -203,7 +187,7 @@ html
|
||||
border-color: darken($link-color, 5%)
|
||||
img
|
||||
display: block
|
||||
margin: auto auto ($gutter / 2) auto
|
||||
margin: auto auto $gutter / 2 auto
|
||||
height: 45px
|
||||
width: 45px
|
||||
background-color: $menu-logo-color
|
||||
@@ -214,11 +198,11 @@ html
|
||||
font-size: 100%
|
||||
font-weight: bold
|
||||
display: inline-block
|
||||
padding: ($base-line-height / 6) ($base-line-height / 4)
|
||||
padding: $base-line-height / 6 $base-line-height / 4
|
||||
margin-bottom: $gutter / 2
|
||||
max-width: 100%
|
||||
&:hover, &active, &focus
|
||||
background: rgba(255, 255, 255, 0.1)
|
||||
+font-smooth
|
||||
&:hover
|
||||
background: rgba(255,255,255,.1)
|
||||
img.logo
|
||||
display: block // display on its own line all the time
|
||||
margin: 0 auto
|
||||
@@ -226,57 +210,16 @@ html
|
||||
width: auto
|
||||
border-radius: 0
|
||||
max-width: 100% // shrink on mobile, if appropriate
|
||||
background: rgba(0, 0, 0, 0) // make hover background of parent show up properly
|
||||
background: rgba(0,0,0,0) // make hover background of parent show up properly
|
||||
&.icon
|
||||
display: block
|
||||
img.logo
|
||||
margin-top: 0.85em // space it away from the title text
|
||||
> div.switch-menus
|
||||
position: relative
|
||||
display: block
|
||||
margin-top: -1 * $gutter / 4
|
||||
> div.version
|
||||
margin-top: -1 * ($gutter / 4)
|
||||
margin-bottom: $gutter / 2
|
||||
font-weight: normal
|
||||
color: rgba(255, 255,255, 0.3)
|
||||
> div.version-switch, > div.language-switch
|
||||
display: inline-block
|
||||
padding: .2em
|
||||
select
|
||||
// Provide room for dropdown icon
|
||||
display: inline-block
|
||||
margin-right: -2rem
|
||||
padding-right: 2rem
|
||||
max-width: $nav-desktop-width * .8
|
||||
// Alter base select styles
|
||||
text-align-last: center
|
||||
background: none
|
||||
border: none
|
||||
border-radius: 0em
|
||||
box-shadow: none
|
||||
font-family: $base-font-family
|
||||
font-size: 1em
|
||||
font-weight: normal
|
||||
color: rgba(255, 255, 255, .3)
|
||||
cursor: pointer
|
||||
// Allow for padding
|
||||
appearance: none
|
||||
-webkit-appearance: none
|
||||
-moz-appearance: none
|
||||
&:hover, &:active, &:focus
|
||||
background: rgba(255, 255, 255, .1)
|
||||
color: rgba(255, 255, 255, .5)
|
||||
&:has(> select):after
|
||||
display: inline-block
|
||||
width: 1.5em
|
||||
height: 100%
|
||||
padding: .1em
|
||||
content: "\f0d7"
|
||||
font-size: 1em
|
||||
line-height: 1.2em
|
||||
font-family: FontAwesome
|
||||
text-align: center
|
||||
pointer-events: none
|
||||
box-sizing: border-box
|
||||
color: rgba(255,255,255,.3)
|
||||
|
||||
|
||||
.wy-nav .wy-menu-vertical
|
||||
header
|
||||
@@ -288,7 +231,7 @@ html
|
||||
color: $white
|
||||
|
||||
[data-menu-wrap]
|
||||
+transition(all 0.2s ease-in)
|
||||
+transition(all .2s ease-in)
|
||||
position: absolute
|
||||
opacity: 1
|
||||
width: 100%
|
||||
@@ -306,6 +249,7 @@ html
|
||||
left: auto
|
||||
opacity: 0
|
||||
|
||||
|
||||
.wy-body-for-nav
|
||||
background: $section-background-color
|
||||
|
||||
@@ -339,7 +283,7 @@ html
|
||||
display: none
|
||||
background: $link-color
|
||||
color: $white
|
||||
padding: ($gutter / 4) ($gutter / 2)
|
||||
padding: $gutter / 4 $gutter / 2
|
||||
position: relative
|
||||
line-height: 50px
|
||||
text-align: center
|
||||
@@ -348,6 +292,7 @@ html
|
||||
a
|
||||
color: $white
|
||||
font-weight: bold
|
||||
+font-smooth
|
||||
img
|
||||
margin-right: $base-line-height / 2
|
||||
height: 45px
|
||||
@@ -367,7 +312,7 @@ html
|
||||
min-height: 100%
|
||||
|
||||
.wy-nav-content
|
||||
padding: $gutter ($gutter * 2)
|
||||
padding: $gutter $gutter * 2
|
||||
height: 100%
|
||||
max-width: $nav-content-width
|
||||
margin: auto
|
||||
@@ -376,7 +321,7 @@ html
|
||||
position: fixed
|
||||
width: 100%
|
||||
height: 100%
|
||||
background: rgba(0, 0, 0, 0.2)
|
||||
background: rgba(0,0,0,.2)
|
||||
display: none
|
||||
z-index: $z-index-modal - 1
|
||||
&.on
|
||||
@@ -419,7 +364,7 @@ footer
|
||||
font-size: 90%
|
||||
|
||||
.genindextable li > ul
|
||||
margin-left: $base-line-height
|
||||
margin-left: $base-line-height
|
||||
|
||||
+media($tablet)
|
||||
.wy-body-for-nav
|
||||
@@ -454,7 +399,7 @@ footer
|
||||
|
||||
@media screen and (min-width: $nav-media-query)
|
||||
.wy-nav-content-wrap
|
||||
background: rgba(0, 0, 0, 0.05)
|
||||
background: rgba(0,0,0,.05)
|
||||
.wy-nav-content
|
||||
margin: 0
|
||||
background: $section-background-color
|
||||
File renamed without changes.
@@ -5,7 +5,7 @@
|
||||
// 1. Lots of this @extends from wyrm_core/_type.sass (http://www.github.com/snide/wyrm/.
|
||||
// * Try not to replace any @extends code. It's pretty generic stuff meant to work together.
|
||||
// * That said, know that I'm very unlikely to accept PRs from wyrm just to change style here.
|
||||
// 2. I plan to remove the !importants in here. Part of it is due to laziness, part to sphinx's fondness for nesting.
|
||||
// 2. I plan to remove the !importants in here. Part of it is due to lazyness, part to sphinx's fondness for nesting.
|
||||
// 3. Try to use variables from wyrm_core/wy_variables.sass. Notable are...
|
||||
// * $base-line-height // All margins, padding and line-height should use this in .25 increments.
|
||||
// * $text-color, $text-light, $text-dark...etc
|
||||
@@ -14,28 +14,24 @@
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.rst-content
|
||||
// Some browsers like to give arbitrary margins :( make them all consistent.
|
||||
h1, h2, h3, h4, h5, h6
|
||||
margin-bottom: $base-line-height
|
||||
|
||||
// Sphinx by default applies HxW style attributes to images. This fixes that oversite.
|
||||
img
|
||||
max-width: 100%
|
||||
height: auto
|
||||
|
||||
div.figure, figure
|
||||
div.figure
|
||||
margin-bottom: $base-line-height
|
||||
.caption-text
|
||||
p.caption
|
||||
font-style: italic
|
||||
p:last-child.caption
|
||||
margin-bottom: 0px
|
||||
&.align-center
|
||||
text-align: center
|
||||
|
||||
div.figure.align-center
|
||||
text-align: center
|
||||
|
||||
// Usually it's a good idea to give images some space.
|
||||
.section >, section >
|
||||
img, a > img
|
||||
margin-bottom: $base-line-height
|
||||
.section > img, .section > a > img
|
||||
margin-bottom: $base-line-height
|
||||
|
||||
// normalize browser styling
|
||||
abbr[title]
|
||||
@@ -60,7 +56,7 @@
|
||||
pre.literal-block
|
||||
white-space: pre
|
||||
margin: 0
|
||||
padding: ($base-line-height / 2) ($base-line-height / 2)
|
||||
padding: $base-line-height / 2 $base-line-height / 2
|
||||
font-family: $code-font-family
|
||||
display: block
|
||||
overflow: auto
|
||||
@@ -79,39 +75,26 @@
|
||||
.linenodiv pre
|
||||
border-right: solid 1px lighten($table-border-color, 2%)
|
||||
margin: 0
|
||||
padding: ($base-line-height / 2) ($base-line-height / 2)
|
||||
padding: $base-line-height / 2 $base-line-height / 2
|
||||
font-family: $code-font-family
|
||||
user-select: none
|
||||
pointer-events: none
|
||||
div[class^='highlight'] pre
|
||||
white-space: pre
|
||||
margin: 0
|
||||
padding: ($base-line-height / 2) ($base-line-height / 2)
|
||||
padding: $base-line-height / 2 $base-line-height / 2
|
||||
display: block
|
||||
overflow: auto
|
||||
& .hll
|
||||
// Line emphasis spans full width
|
||||
display: block
|
||||
margin: 0 (-1 * $base-line-height / 2)
|
||||
padding: 0 ($base-line-height / 2)
|
||||
margin: 0 -1 * $base-line-height / 2
|
||||
padding: 0 $base-line-height / 2
|
||||
pre.literal-block, div[class^='highlight'] pre, .linenodiv pre
|
||||
font-family: $code-font-family
|
||||
font-size: 12px
|
||||
line-height: 1.4
|
||||
|
||||
// Do not allow selection of code block prompts and line numbers
|
||||
div.highlight
|
||||
span.linenos, .gp
|
||||
user-select: none
|
||||
pointer-events: none
|
||||
|
||||
span.linenos
|
||||
display: inline-block
|
||||
padding-left: 0px
|
||||
padding-right: ($base-line-height / 2)
|
||||
margin-right: ($base-line-height / 2)
|
||||
border-right: 1px solid lighten($table-border-color, 2%)
|
||||
|
||||
.code-block-caption
|
||||
font-style: italic
|
||||
font-size: 85%
|
||||
@@ -128,8 +111,8 @@
|
||||
@extend .wy-alert
|
||||
// These block elements are unsuitable for having floating objects next
|
||||
// to them
|
||||
clear: both
|
||||
.last, > *:last-child
|
||||
clear: both;
|
||||
.last
|
||||
margin-bottom: 0
|
||||
.admonition-title
|
||||
@extend .wy-alert-title
|
||||
@@ -147,43 +130,22 @@
|
||||
@extend .wy-alert.wy-alert-warning
|
||||
// Some people put tables in notes. Let's give them very basic support.
|
||||
.admonition table
|
||||
border-color: rgba(0, 0, 0, 0.1)
|
||||
border-color: rgba(0,0,0,.1)
|
||||
td, th
|
||||
background: transparent !important
|
||||
border-color: rgba(0, 0, 0, 0.1) !important
|
||||
|
||||
.section, section, .toctree-wrapper
|
||||
ul
|
||||
@extend .wy-plain-list-disc
|
||||
ol.loweralpha, ol.loweralpha > li
|
||||
list-style: lower-alpha
|
||||
ol.upperalpha, ol.upperalpha > li
|
||||
list-style: upper-alpha
|
||||
ol, ol.arabic
|
||||
@extend .wy-plain-list-decimal
|
||||
// Complex bullet lists, they have more item margins than simple lists
|
||||
ol li, ul li
|
||||
> *
|
||||
margin-top: $base-line-height / 2
|
||||
margin-bottom: $base-line-height / 2
|
||||
&:first-child
|
||||
margin-top: 0rem
|
||||
> p
|
||||
&, &:last-child
|
||||
margin-bottom: $base-line-height / 2
|
||||
&:only-child, &:only-child:last-child
|
||||
margin-bottom: 0rem
|
||||
> ul, > ol
|
||||
margin-bottom: $base-line-height / 2
|
||||
// Simple lists, no item margins
|
||||
ol.simple li, ul.simple li
|
||||
> *
|
||||
margin-top: 0rem
|
||||
margin-bottom: 0rem
|
||||
ul, ol
|
||||
margin-top: 0rem
|
||||
margin-bottom: 0rem
|
||||
|
||||
border-color: rgba(0,0,0,.1) !important
|
||||
.section ul, .toctree-wrapper ul
|
||||
@extend .wy-plain-list-disc
|
||||
.section ol.loweralpha, .section ol.loweralpha li
|
||||
list-style: lower-alpha
|
||||
.section ol.upperalpha, .section ol.upperalpha li
|
||||
list-style: upper-alpha
|
||||
.section ol, ol.arabic
|
||||
@extend .wy-plain-list-decimal
|
||||
.section ol p, .section ul p
|
||||
margin-bottom: $base-line-height / 2
|
||||
&:last-child
|
||||
margin-bottom: $base-line-height
|
||||
.line-block
|
||||
margin-left: 0px
|
||||
margin-bottom: $base-line-height
|
||||
@@ -209,34 +171,20 @@
|
||||
// Do not override display:table for tables
|
||||
&:not(table)
|
||||
display: block
|
||||
.toctree-wrapper > p.caption
|
||||
.toctree-wrapper p.caption
|
||||
@extend h2
|
||||
|
||||
// This is the #href that shows up on hover. Sphinx's is terrible so I hack it away.
|
||||
h1, h2, h3, h4, h5, h6, dl dt, p, p.caption, table > caption, .code-block-caption, .eqno
|
||||
h1, h2, h3, h4, h5, h6, dl dt, p.caption, table > caption, .code-block-caption
|
||||
.headerlink
|
||||
opacity: 0
|
||||
visibility: hidden
|
||||
font-size: 14px
|
||||
font-family: FontAwesome
|
||||
margin-left: 0.5em
|
||||
@extend .fa
|
||||
&:focus
|
||||
opacity: 1
|
||||
&:hover .headerlink
|
||||
opacity: 1
|
||||
|
||||
// Make links inside paragraphs wrap when they are too long
|
||||
p a
|
||||
overflow-wrap: anywhere
|
||||
// Consistent font sizing for table typography
|
||||
.wy-table
|
||||
th, td
|
||||
p, ul
|
||||
font-size: inherit
|
||||
|
||||
// override the Wyrm accessibility anti-pattern of hiding button focus
|
||||
.btn:focus
|
||||
outline: 2px solid
|
||||
&:after
|
||||
content: "\f0c1"
|
||||
font-family: FontAwesome
|
||||
&:hover .headerlink:after
|
||||
visibility: visible
|
||||
|
||||
table > caption .headerlink:after
|
||||
font-size: 12px
|
||||
@@ -256,23 +204,23 @@
|
||||
// Sidebar content is usually less relevant, so adjust the margins and sizes.
|
||||
p, ul, dl
|
||||
font-size: 90%
|
||||
.last, > *:last-child
|
||||
.last
|
||||
margin-bottom: 0
|
||||
.sidebar-title
|
||||
display: block
|
||||
font-family: $custom-font-family
|
||||
font-weight: bold
|
||||
background: $table-border-color
|
||||
padding: ($base-line-height / 4) ($base-line-height / 2)
|
||||
padding: $base-line-height / 4 $base-line-height / 2
|
||||
margin: -$base-line-height
|
||||
margin-bottom: $base-line-height
|
||||
font-size: 100%
|
||||
// Sphinx can highlight searched text with ?highlighted=searchterm
|
||||
.highlighted
|
||||
background: $highlight-color
|
||||
box-shadow: 0 0 0 ($base-line-height / 12) $highlight-color
|
||||
display: inline
|
||||
display: inline-block
|
||||
font-weight: bold
|
||||
padding: 0 $base-line-height / 4
|
||||
|
||||
// These are the little citation links [1] that show up within paragraphs.
|
||||
.footnote-reference, .citation-reference
|
||||
@@ -281,139 +229,23 @@
|
||||
top: -0.4em
|
||||
line-height: 0
|
||||
font-size: 90%
|
||||
> span.fn-bracket
|
||||
display: none
|
||||
|
||||
// Horizontal lists have multiple columns; use full width
|
||||
.hlist
|
||||
width: 100%
|
||||
|
||||
// Definition lists term/classifier separator
|
||||
// Adds a separator for Sphinx > 1.x as a pseudo-element
|
||||
// and hides the hardcoded separator from Sphinx 1.x
|
||||
dl dt span.classifier
|
||||
&:before
|
||||
content: " : "
|
||||
dl dt span.classifier-delimiter
|
||||
display: none !important
|
||||
|
||||
// The html4 writer outputs the citation and footnotes as a table, and the
|
||||
// html5 writer outputs these as a definition list (docutils < 0.18) or an
|
||||
// aside/div (docutils 0.18+). We will use the fairly well supported css
|
||||
// `grid` attributes to make these back into a table
|
||||
// HTML4 writer
|
||||
html.writer-html4 &
|
||||
table.docutils.citation, table.docutils.footnote
|
||||
background: none
|
||||
border: none
|
||||
td, tr
|
||||
border: none
|
||||
background-color: transparent !important
|
||||
white-space: normal
|
||||
td.label
|
||||
padding-left: 0
|
||||
padding-right: 0
|
||||
vertical-align: top
|
||||
// HTML5 writer
|
||||
html.writer-html5 &
|
||||
// docutils < 0.18 grid layout. Some spacing is the dl/dt/dd margins
|
||||
dl.footnote, dl.citation, dl.field-list
|
||||
display: grid
|
||||
grid-template-columns: auto minmax(80%, 95%)
|
||||
> dt
|
||||
display: inline-grid
|
||||
grid-template-columns: max-content auto
|
||||
// docutils => 0.18 grid layout
|
||||
aside.footnote, aside.citation, div.citation
|
||||
display: grid
|
||||
// Two any width columns for label and backrefs, a noop column to expand
|
||||
// to fill the width allocated to the first two columns, and then the
|
||||
// content column for the paragraphs.
|
||||
grid-template-columns: auto auto minmax(0.65rem, auto) minmax(40%, 95%)
|
||||
& > span.label
|
||||
grid-column-start: 1
|
||||
grid-column-end: 2
|
||||
& > span.backrefs
|
||||
grid-column-start: 2
|
||||
grid-column-end: 3
|
||||
grid-row-start: 1
|
||||
grid-row-end: 3
|
||||
& > p
|
||||
grid-column-start: 4
|
||||
grid-column-end: 5
|
||||
|
||||
// Shared backrefs styling for docutils versions
|
||||
@mixin footnote-backrefs
|
||||
text-align: left
|
||||
font-style: italic
|
||||
margin-left: .65rem
|
||||
word-break: break-word
|
||||
word-spacing: -0.1rem
|
||||
max-width: 5rem
|
||||
|
||||
> a
|
||||
&:not(:first-child)::before
|
||||
content: " "
|
||||
word-break: keep-all
|
||||
|
||||
// docutils < 0.18 html5 writer styling
|
||||
dl.footnote, dl.citation, dl.field-list,
|
||||
margin-bottom: $base-line-height
|
||||
> dt
|
||||
padding-left: 1rem
|
||||
> dt, > dd
|
||||
margin-bottom: 0rem
|
||||
dl.footnote, dl.citation
|
||||
font-size: .9rem
|
||||
> dt
|
||||
margin: 0rem 0.5rem 0.5rem 0rem
|
||||
line-height: 1.2rem
|
||||
word-break: break-all
|
||||
font-weight: normal
|
||||
> span.brackets
|
||||
&:before
|
||||
content: "["
|
||||
&:after
|
||||
content: "]"
|
||||
> span.fn-backref
|
||||
@include footnote-backrefs
|
||||
> dd
|
||||
margin: 0rem 0rem 0.5rem 0rem
|
||||
line-height: 1.2rem
|
||||
p
|
||||
font-size: 0.9rem
|
||||
|
||||
// docutils => 0.18 html5 writer styling
|
||||
aside.footnote, aside.citation, div.citation
|
||||
padding-left: 1rem
|
||||
padding-right: 1rem
|
||||
font-size: 0.9rem
|
||||
line-height: 1.2rem
|
||||
p
|
||||
font-size: 0.9rem
|
||||
line-height: 1.2rem
|
||||
margin-bottom: $base-line-height / 2
|
||||
span.backrefs
|
||||
@include footnote-backrefs
|
||||
span.label
|
||||
line-height: 1.2rem
|
||||
aside.footnote-list, aside.citation-list, div.citation-list
|
||||
margin-bottom: $base-line-height
|
||||
|
||||
dl.option-list
|
||||
kbd
|
||||
font-size: 0.9rem
|
||||
// Both
|
||||
html.writer-html4 & table.docutils.citation, table.docutils.footnote,
|
||||
html.writer-html5 & dl.footnote,
|
||||
html.writer-html5 & dl.citation,
|
||||
html.writer-html5 & aside.footnote,
|
||||
html.writer-html5 & aside.footnote-list aside.footnote,
|
||||
html.writer-html5 & div.citation-list > div.citation
|
||||
// Tables! Sphinx LOVES TABLES. Most of wyrm assumes you're only going to use a table as a table
|
||||
// so I have to write a bunch of unique stuff for Sphinx to style them up differently like it's 2003.
|
||||
table.docutils.citation, table.docutils.footnote
|
||||
background: none
|
||||
border: none
|
||||
color: $text-medium
|
||||
td, tr
|
||||
border: none
|
||||
background-color: transparent !important
|
||||
white-space: normal
|
||||
td.label
|
||||
padding-left: 0
|
||||
padding-right: 0
|
||||
vertical-align: top
|
||||
code
|
||||
color: $gray
|
||||
|
||||
// Remove the large vertical space between citations and footnotes
|
||||
.wy-table-responsive.citation, .wy-table-responsive.footnote
|
||||
margin-bottom: 0
|
||||
@@ -430,17 +262,10 @@
|
||||
@extend .wy-table-bordered-all
|
||||
th
|
||||
border-color: $table-border-color
|
||||
html.writer-html5 &
|
||||
border: 1px solid $table-border-color
|
||||
html.writer-html5 &
|
||||
th > p, td > p
|
||||
line-height: 1rem
|
||||
margin-bottom: 0rem
|
||||
font-size: 0.9rem
|
||||
&:not(.field-list)
|
||||
@extend .wy-table-striped
|
||||
// Remove bottom margin for the last element (and it's last child)
|
||||
td .last, td .last > *:last-child
|
||||
td .last, td .last :last-child
|
||||
margin-bottom: 0
|
||||
// This table is what gets spit out for auto-generated API stuff. I style it smaller bits of padding.
|
||||
table.field-list
|
||||
@@ -449,6 +274,7 @@
|
||||
td
|
||||
border: none
|
||||
p
|
||||
font-size: inherit
|
||||
line-height: inherit
|
||||
td > strong
|
||||
display: inline-block
|
||||
@@ -471,12 +297,9 @@
|
||||
|
||||
&.literal
|
||||
color: $text-code-color
|
||||
white-space: normal
|
||||
&.xref, a &
|
||||
font-weight: bold
|
||||
color: $text-codexref-color
|
||||
// https://github.com/readthedocs/sphinx_rtd_theme/issues/1368
|
||||
overflow-wrap: normal
|
||||
pre, kbd, samp
|
||||
font-family: $code-font-family
|
||||
// If the literal is inside an a tag, let's color it like a link
|
||||
@@ -489,22 +312,22 @@
|
||||
margin-bottom: $base-line-height / 2
|
||||
// Most of the content within these dls are one liners, so I halve the normal margins.
|
||||
p, table, ul, ol
|
||||
margin-bottom: $base-line-height / 2
|
||||
margin-bottom: $base-line-height / 2 !important
|
||||
// rST seems to want dds to be treated as the browser would, indented.
|
||||
dd
|
||||
margin: 0 0 ($base-line-height / 2) $base-line-height
|
||||
margin: 0 0 $base-line-height / 2 $base-line-height
|
||||
line-height: $base-line-height
|
||||
> p:last-child,
|
||||
> ol:last-child,
|
||||
> ul:last-child,
|
||||
> table:last-child
|
||||
margin-bottom: 0
|
||||
html.writer-html4 & dl:not(.docutils),
|
||||
html.writer-html5 & dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)
|
||||
// This is what Sphinx spits out for it's autodocs. Depending upon what language the person is referencing
|
||||
// these things usually have a class of "method" or "class" or something similar, but really who knows.
|
||||
// Sphinx doesn't give me a generic class on these, so unfortunately I have to apply it to the root dl.
|
||||
// This makes me terribly unhappy and makes this code very nesty. Unfortunately I've seen hand-written docs
|
||||
// that output similar, but not quite the same nesting so this is really the best we can do.
|
||||
dl:not(.docutils)
|
||||
margin-bottom: $base-line-height
|
||||
> dt
|
||||
// This would be the equivilant of a .. class::
|
||||
dt
|
||||
display: table
|
||||
margin: ($base-line-height / 4) 0
|
||||
margin: $base-line-height / 4 0
|
||||
font-size: 90%
|
||||
line-height: normal
|
||||
background: lighten($class-color, 50%)
|
||||
@@ -517,21 +340,21 @@
|
||||
.headerlink
|
||||
color: $text-color
|
||||
font-size: 100% !important
|
||||
// In the html4 writer, parameters is a table. In html5 writer, parameters
|
||||
// is a nested dl.field-list
|
||||
dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) > dt
|
||||
// And this would be the .. method::
|
||||
dl dt
|
||||
margin-bottom: $base-line-height / 4
|
||||
border: none
|
||||
border-left: solid 3px hsl(0, 0%, 80%)
|
||||
background: hsl(0, 0%, 94%)
|
||||
border-left: solid 3px hsl(0,0%,80%)
|
||||
background: hsl(0,0%,94%)
|
||||
color: $method-color
|
||||
.headerlink
|
||||
color: $headerlink-color
|
||||
font-size: 100% !important
|
||||
> dt:first-child
|
||||
dt:first-child
|
||||
margin-top: 0
|
||||
// Since dts get the callout style, we treat this less as callouts.
|
||||
tt, code
|
||||
font-weight: bold
|
||||
&.descname, &.descclassname
|
||||
background-color: transparent
|
||||
border: none
|
||||
@@ -548,13 +371,6 @@
|
||||
.property
|
||||
display: inline-block
|
||||
padding-right: 8px
|
||||
max-width: 100%
|
||||
// This is keywords such as "const"
|
||||
.k
|
||||
font-style: italic
|
||||
.sig-name, .descname, .descclassname
|
||||
font-family: $code-font-family
|
||||
color: $black
|
||||
// Doc links to sourcecode
|
||||
.viewcode-link, .viewcode-back
|
||||
display: inline-block
|
||||
@@ -583,29 +399,14 @@
|
||||
@extend .fa-download
|
||||
&:before
|
||||
margin-right: 4px
|
||||
.guilabel,
|
||||
.menuselection
|
||||
.guilabel
|
||||
border: 1px solid lighten($guilabel-color, 25%)
|
||||
background: lighten($guilabel-color, 50%)
|
||||
font-size: 80%
|
||||
font-weight: 700
|
||||
border-radius: $base-line-height / 6
|
||||
padding: ($base-line-height / 10) ($base-line-height / 4)
|
||||
margin: auto ($base-line-height / 12)
|
||||
.guilabel,
|
||||
border: 1px solid lighten($guilabel-color, 25%)
|
||||
background: lighten($guilabel-color, 50%)
|
||||
.menuselection
|
||||
border: 1px solid lighten($menuselection-color, 25%)
|
||||
background: lighten($menuselection-color, 50%)
|
||||
*:not(dl.option-list) > :not(dt):not(kbd):not(.kbd) > kbd,
|
||||
*:not(dl.option-list) > :not(dt):not(kbd):not(.kbd) > .kbd
|
||||
color: inherit
|
||||
font-size: 80%
|
||||
background-color: lighten($text-light, 30%)
|
||||
border: 1px solid darken($text-light, 5%)
|
||||
border-radius: $base-line-height / 6
|
||||
box-shadow: grey 0px $base-line-height / 12
|
||||
padding: $base-line-height / 10 $base-line-height / 4
|
||||
margin: auto 0
|
||||
margin: auto $base-line-height / 12
|
||||
.versionmodified
|
||||
font-style: italic
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
// In here are variables used for sphinx_rtd_theme, they either add to or overwrite the default ones
|
||||
// In here are varibles used for sphinx_rtd_theme, they either add to or overwrite the default ones
|
||||
// that are set in wyrm_core/wy_variables.sass. You'll find wyrm in bower_components if you're looking
|
||||
// for a reference.
|
||||
|
||||
$fa-font-path: "~font-awesome/fonts"
|
||||
$font-awesome-dir: "../fonts/"
|
||||
$static-img: "../img/"
|
||||
|
||||
$nav-content-width: 800px
|
||||
$nav-media-query: $nav-desktop-width + $nav-content-width
|
||||
$nav-media-query: (($nav-desktop-width) + ($nav-content-width))
|
||||
|
||||
$mathjax-color: $text-color
|
||||
|
||||
@@ -20,12 +20,9 @@ $text-codexref-color: $text-color
|
||||
$class-color: $blue
|
||||
$method-color: $gray
|
||||
|
||||
// :guilabel: color
|
||||
// GUI label color
|
||||
$guilabel-color: $blue
|
||||
|
||||
// :menuselection: label color
|
||||
$menuselection-color: $blue
|
||||
|
||||
// Footer colors
|
||||
$footer-color: $text-medium
|
||||
|
||||
@@ -54,7 +51,7 @@ $nav-link-color: $blue
|
||||
$nav-link-color-visited: $purple
|
||||
$nav-link-color-hover: lighten($nav-link-color, 6%) !default
|
||||
$nav-link-color-alt: hsl(33, 100%, 51%)
|
||||
$nav-caption: lighten($blue, 15%)
|
||||
$nav-caption: desaturate($blue, 15%)
|
||||
|
||||
// Sidebar colors
|
||||
$sidebar-background-color: $table-stripe-color
|
||||
@@ -68,5 +65,3 @@ $base-font-family: "Lato", "proxima-nova", "Helvetica Neue",
|
||||
$custom-font-family: "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif
|
||||
$custom-font-family2: Georgia, serif
|
||||
$code-font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", Courier, monospace
|
||||
|
||||
$font-display: block
|
||||
@@ -8,8 +8,8 @@ $border-box-sizing: false !default
|
||||
|
||||
@import wyrm_core/wy_variables
|
||||
@import theme_variables
|
||||
@import ~bourbon/app/assets/stylesheets/bourbon
|
||||
@import ~bourbon-neat/app/assets/stylesheets/neat
|
||||
@import bourbon
|
||||
@import neat
|
||||
@import wyrm_core/mixin
|
||||
@import wyrm_core/grid_settings
|
||||
@import _theme_badge_fa
|
||||
@@ -13,11 +13,11 @@
|
||||
@import theme_variables
|
||||
|
||||
// bourbon.io framework
|
||||
@import ~bourbon/app/assets/stylesheets/bourbon
|
||||
@import bourbon
|
||||
|
||||
// Bourbon.io/neat framework, with some default media queries
|
||||
@import wyrm_core/grid_settings
|
||||
@import ~bourbon-neat/app/assets/stylesheets/neat
|
||||
@import neat
|
||||
// Some corrections for neat
|
||||
@import wyrm_core/neat_extra
|
||||
|
||||
@@ -27,8 +27,8 @@
|
||||
// Wyrm mixins
|
||||
@import wyrm_core/mixin
|
||||
|
||||
// Font Awesome with wyrm extras
|
||||
@import ~font-awesome/scss/font-awesome
|
||||
// Font Awesome 4.0 with wyrm extras
|
||||
@import font-awesome
|
||||
@import wyrm_core/font_icon_defaults
|
||||
|
||||
// Wyrm core styles used in this theme
|
||||
@@ -1,116 +1,2 @@
|
||||
[bumpversion]
|
||||
current_version = 3.0.0rc2
|
||||
commit = false
|
||||
tag = false
|
||||
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>[a-z]+)(?P<dev>\d+))?
|
||||
serialize =
|
||||
{major}.{minor}.{patch}{release}{dev}
|
||||
{major}.{minor}.{patch}
|
||||
|
||||
[metadata]
|
||||
name = sphinx_rtd_theme
|
||||
url = https://github.com/readthedocs/sphinx_rtd_theme
|
||||
license = MIT
|
||||
author = Dave Snider, Read the Docs, Inc. & contributors
|
||||
author_email = dev@readthedocs.org
|
||||
description = Read the Docs theme for Sphinx
|
||||
long_description = file: README.rst
|
||||
project_urls =
|
||||
Homepage = https://sphinx-rtd-theme.readthedocs.io/
|
||||
Source Code = https://github.com/readthedocs/sphinx_rtd_theme
|
||||
Issue Tracker = https://github.com/readthedocs/sphinx_rtd_theme/issues
|
||||
classifiers =
|
||||
Framework :: Sphinx
|
||||
Framework :: Sphinx :: Theme
|
||||
Development Status :: 5 - Production/Stable
|
||||
License :: OSI Approved :: MIT License
|
||||
Environment :: Console
|
||||
Environment :: Web Environment
|
||||
Intended Audience :: Developers
|
||||
Programming Language :: Python :: 3
|
||||
Programming Language :: Python :: 3 :: Only
|
||||
Programming Language :: Python :: 3.8
|
||||
Programming Language :: Python :: 3.9
|
||||
Programming Language :: Python :: 3.10
|
||||
Programming Language :: Python :: 3.11
|
||||
Programming Language :: Python :: 3.12
|
||||
Operating System :: OS Independent
|
||||
Topic :: Documentation
|
||||
Topic :: Software Development :: Documentation
|
||||
|
||||
[options]
|
||||
include_package_data = True
|
||||
zip_safe = False
|
||||
packages = sphinx_rtd_theme
|
||||
python_requires = >=3.8
|
||||
install_requires =
|
||||
sphinx >=6,<9
|
||||
docutils >0.18,<0.22
|
||||
sphinxcontrib-jquery >=4,<5
|
||||
tests_require =
|
||||
pytest
|
||||
|
||||
[options.extras_require]
|
||||
dev =
|
||||
transifex-client
|
||||
bump2version
|
||||
wheel
|
||||
twine
|
||||
|
||||
[options.entry_points]
|
||||
sphinx.html_themes =
|
||||
sphinx_rtd_theme = sphinx_rtd_theme
|
||||
|
||||
[options.package_data]
|
||||
sphinx_rtd_theme =
|
||||
theme.conf
|
||||
*.html
|
||||
static/css/*.css
|
||||
static/css/fonts/*.*
|
||||
static/js/*.js
|
||||
|
||||
[bdist_wheel]
|
||||
universal = 1
|
||||
|
||||
[extract_messages]
|
||||
mapping_file = babel.cfg
|
||||
output_file = sphinx_rtd_theme/locale/sphinx.pot
|
||||
keywords = _ l_ lazy_gettext
|
||||
add_comments = Translators:
|
||||
|
||||
[init_catalog]
|
||||
domain = sphinx
|
||||
input_file = sphinx_rtd_theme/locale/sphinx.pot
|
||||
output_dir = sphinx_rtd_theme/locale/
|
||||
|
||||
[update_catalog]
|
||||
domain = sphinx
|
||||
input_file = sphinx_rtd_theme/locale/sphinx.pot
|
||||
output_dir = sphinx_rtd_theme/locale/
|
||||
|
||||
[compile_catalog]
|
||||
domain = sphinx
|
||||
directory = sphinx_rtd_theme/locale/
|
||||
|
||||
[bumpversion:part:release]
|
||||
optional_value = release
|
||||
first_value = alpha
|
||||
values =
|
||||
alpha
|
||||
rc
|
||||
release
|
||||
|
||||
[bumpversion:part:dev]
|
||||
first_value = 1
|
||||
|
||||
[bumpversion:file:setup.py]
|
||||
|
||||
[bumpversion:file:sphinx_rtd_theme/__init__.py]
|
||||
|
||||
[bumpversion:file:package.json]
|
||||
search = "version": "{current_version}",
|
||||
replace = "version": "{new_version}",
|
||||
|
||||
[bumpversion:file:docs/changelog.rst]
|
||||
search = .. |theme_version| replace:: {current_version}
|
||||
replace = .. |theme_version| replace:: {new_version}
|
||||
@@ -1,96 +1,58 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""`sphinx_rtd_theme` lives on `Github`_.
|
||||
|
||||
import distutils.cmd
|
||||
import os
|
||||
import subprocess
|
||||
.. _github: https://github.com/rtfd/sphinx_rtd_theme
|
||||
|
||||
"""
|
||||
from io import open
|
||||
|
||||
from setuptools import setup
|
||||
|
||||
|
||||
class WebpackBuildCommand(distutils.cmd.Command):
|
||||
|
||||
description = "Generate static assets"
|
||||
|
||||
user_options = []
|
||||
|
||||
def initialize_options(self):
|
||||
pass
|
||||
|
||||
def finalize_options(self):
|
||||
pass
|
||||
|
||||
def run(self):
|
||||
if not 'CI' in os.environ and not 'TOX_ENV_NAME' in os.environ:
|
||||
subprocess.run(['npm', 'install'], check=True)
|
||||
subprocess.run(['node_modules/.bin/webpack', '--config', 'webpack.prod.js'], check=True)
|
||||
|
||||
|
||||
class WebpackDevelopCommand(distutils.cmd.Command):
|
||||
|
||||
description = "Run Webpack dev server"
|
||||
|
||||
user_options = []
|
||||
|
||||
def initialize_options(self):
|
||||
pass
|
||||
|
||||
def finalize_options(self):
|
||||
pass
|
||||
|
||||
def run(self):
|
||||
subprocess.run(
|
||||
["node_modules/.bin/webpack-dev-server", "--open", "--config", "webpack.dev.js"],
|
||||
check=True
|
||||
)
|
||||
|
||||
|
||||
class UpdateTranslationsCommand(distutils.cmd.Command):
|
||||
|
||||
description = "Run all localization commands"
|
||||
|
||||
user_options = []
|
||||
sub_commands = [
|
||||
('extract_messages', None),
|
||||
('update_catalog', None),
|
||||
('transifex', None),
|
||||
('compile_catalog', None),
|
||||
]
|
||||
|
||||
def initialize_options(self):
|
||||
pass
|
||||
|
||||
def finalize_options(self):
|
||||
pass
|
||||
|
||||
def run(self):
|
||||
for cmd_name in self.get_sub_commands():
|
||||
self.run_command(cmd_name)
|
||||
|
||||
|
||||
class TransifexCommand(distutils.cmd.Command):
|
||||
|
||||
description = "Update translation files through Transifex"
|
||||
|
||||
user_options = []
|
||||
|
||||
def initialize_options(self):
|
||||
pass
|
||||
|
||||
def finalize_options(self):
|
||||
pass
|
||||
|
||||
def run(self):
|
||||
subprocess.run(['tx', 'push', '--source'], check=True)
|
||||
subprocess.run(['tx', 'pull', '--mode', 'onlyreviewed', '-f', '-a'], check=True)
|
||||
from sphinx_rtd_theme import __version__
|
||||
|
||||
|
||||
setup(
|
||||
version='3.0.0rc2',
|
||||
cmdclass={
|
||||
'update_translations': UpdateTranslationsCommand,
|
||||
'transifex': TransifexCommand,
|
||||
'build_assets': WebpackBuildCommand,
|
||||
'watch': WebpackDevelopCommand,
|
||||
name='sphinx_rtd_theme',
|
||||
version=__version__,
|
||||
url='https://github.com/rtfd/sphinx_rtd_theme/',
|
||||
license='MIT',
|
||||
author='Dave Snider, Read the Docs, Inc. & contributors',
|
||||
author_email='dev@readthedocs.org',
|
||||
description='Read the Docs theme for Sphinx',
|
||||
long_description=open('README.rst', encoding='utf-8').read(),
|
||||
zip_safe=False,
|
||||
packages=['sphinx_rtd_theme'],
|
||||
package_data={'sphinx_rtd_theme': [
|
||||
'theme.conf',
|
||||
'*.html',
|
||||
'static/css/*.css',
|
||||
'static/js/*.js',
|
||||
'static/fonts/*.*'
|
||||
]},
|
||||
include_package_data=True,
|
||||
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
|
||||
entry_points = {
|
||||
'sphinx.html_themes': [
|
||||
'sphinx_rtd_theme = sphinx_rtd_theme',
|
||||
]
|
||||
},
|
||||
install_requires=[
|
||||
'sphinx'
|
||||
],
|
||||
classifiers=[
|
||||
'Framework :: Sphinx',
|
||||
'Framework :: Sphinx :: Theme',
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
'Environment :: Console',
|
||||
'Environment :: Web Environment',
|
||||
'Intended Audience :: Developers',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.3',
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
'Programming Language :: Python :: 3.6',
|
||||
'Operating System :: OS Independent',
|
||||
'Topic :: Documentation',
|
||||
'Topic :: Software Development :: Documentation',
|
||||
],
|
||||
)
|
||||
@@ -1,106 +1,21 @@
|
||||
"""
|
||||
Sphinx Read the Docs theme.
|
||||
"""Sphinx ReadTheDocs theme.
|
||||
|
||||
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
|
||||
|
||||
"""
|
||||
|
||||
import os
|
||||
from os import path
|
||||
from sys import version_info as python_version
|
||||
|
||||
from sphinx import version_info as sphinx_version
|
||||
from sphinx.locale import _
|
||||
from sphinx.util.logging import getLogger
|
||||
|
||||
|
||||
__version__ = '3.0.0rc2'
|
||||
__version__ = '0.4.3.dev0'
|
||||
__version_full__ = __version__
|
||||
|
||||
logger = getLogger(__name__)
|
||||
|
||||
|
||||
def get_html_theme_path():
|
||||
"""Return list of HTML theme paths."""
|
||||
logger.warning(
|
||||
_('Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code.')
|
||||
)
|
||||
|
||||
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
|
||||
return cur_dir
|
||||
|
||||
|
||||
def config_initiated(app, config):
|
||||
theme_options = config.html_theme_options or {}
|
||||
if theme_options.get('canonical_url'):
|
||||
logger.warning(
|
||||
_('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.')
|
||||
)
|
||||
|
||||
if theme_options.get("analytics_id"):
|
||||
logger.warning(
|
||||
_('The analytics_id option is deprecated, use the sphinxcontrib-googleanalytics extension instead.')
|
||||
)
|
||||
|
||||
if theme_options.get("analytics_anonymize_ip"):
|
||||
logger.warning(
|
||||
_('The analytics_anonymize_ip option is deprecated, use the sphinxcontrib-googleanalytics extension instead.')
|
||||
)
|
||||
|
||||
if "extra_css_files" in config.html_context:
|
||||
logger.warning(
|
||||
_('The extra_css_file option is deprecated, use the html_css_files option from Sphinx instead.')
|
||||
)
|
||||
|
||||
|
||||
def extend_html_context(app, pagename, templatename, context, doctree):
|
||||
# Add ``sphinx_version_info`` tuple for use in Jinja templates
|
||||
context['sphinx_version_info'] = sphinx_version
|
||||
|
||||
# Inject all the Read the Docs environment variables in the context:
|
||||
# https://docs.readthedocs.io/en/stable/reference/environment-variables.html
|
||||
context['READTHEDOCS'] = os.environ.get("READTHEDOCS", False) == "True"
|
||||
if context['READTHEDOCS']:
|
||||
for key, value in os.environ.items():
|
||||
if key.startswith("READTHEDOCS_"):
|
||||
context[key] = value
|
||||
|
||||
|
||||
|
||||
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
|
||||
def setup(app):
|
||||
if python_version[0] < 3:
|
||||
logger.error("Python 2 is not supported with sphinx_rtd_theme, update to Python 3.")
|
||||
|
||||
app.require_sphinx('6.0')
|
||||
if app.config.html4_writer:
|
||||
logger.error("'html4_writer' is not supported with sphinx_rtd_theme.")
|
||||
|
||||
# Since Sphinx 6, jquery isn't bundled anymore and we need to ensure that
|
||||
# the sphinxcontrib-jquery extension is enabled.
|
||||
# See: https://dev.readthedocs.io/en/latest/design/sphinx-jquery.html
|
||||
if sphinx_version >= (6, 0, 0):
|
||||
# Documentation of Sphinx guarantees that an extension is added and
|
||||
# enabled at most once.
|
||||
# See: https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.setup_extension
|
||||
app.setup_extension("sphinxcontrib.jquery")
|
||||
# However, we need to call the extension's callback since setup_extension doesn't do it
|
||||
# See: https://github.com/sphinx-contrib/jquery/issues/23
|
||||
from sphinxcontrib.jquery import add_js_files as jquery_add_js_files
|
||||
jquery_add_js_files(app, app.config)
|
||||
|
||||
# Register the theme that can be referenced without adding a theme path
|
||||
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
|
||||
|
||||
# Add Sphinx message catalog for newer versions of Sphinx
|
||||
# See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog
|
||||
rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale')
|
||||
app.add_message_catalog('sphinx', rtd_locale_path)
|
||||
app.connect('config-inited', config_initiated)
|
||||
|
||||
# sphinx emits the permalink icon for headers, so choose one more in keeping with our theme
|
||||
app.config.html_permalinks_icon = "\uf0c1"
|
||||
|
||||
# Extend the default context when rendering the templates.
|
||||
app.connect("html-page-context", extend_html_context)
|
||||
|
||||
return {'parallel_read_safe': True, 'parallel_write_safe': True}
|
||||
@@ -1,77 +1,82 @@
|
||||
{%- if meta is defined and meta is not none %}
|
||||
{%- set check_meta = True %}
|
||||
{%- else %}
|
||||
{%- set check_meta = False %}
|
||||
{%- endif %}
|
||||
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
|
||||
|
||||
{%- if check_meta and 'github_url' in meta %}
|
||||
{%- set display_github = True %}
|
||||
{%- endif %}
|
||||
{% if page_source_suffix %}
|
||||
{% set suffix = page_source_suffix %}
|
||||
{% else %}
|
||||
{% set suffix = source_suffix %}
|
||||
{% endif %}
|
||||
|
||||
{%- if check_meta and 'bitbucket_url' in meta %}
|
||||
{%- set display_bitbucket = True %}
|
||||
{%- endif %}
|
||||
{% if meta is defined and meta is not none %}
|
||||
{% set check_meta = True %}
|
||||
{% else %}
|
||||
{% set check_meta = False %}
|
||||
{% endif %}
|
||||
|
||||
{%- if check_meta and 'gitlab_url' in meta %}
|
||||
{%- set display_gitlab = True %}
|
||||
{%- endif %}
|
||||
{% if check_meta and 'github_url' in meta %}
|
||||
{% set display_github = True %}
|
||||
{% endif %}
|
||||
|
||||
{%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
|
||||
{% if check_meta and 'bitbucket_url' in meta %}
|
||||
{% set display_bitbucket = True %}
|
||||
{% endif %}
|
||||
|
||||
{% if check_meta and 'gitlab_url' in meta %}
|
||||
{% set display_gitlab = True %}
|
||||
{% endif %}
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
{#- Translators: This is an ARIA section label for page links, including previous/next page link and links to GitHub/GitLab/etc. -#}
|
||||
<div role="navigation" aria-label="{{ _('Page navigation') }}">
|
||||
<ul class="wy-breadcrumbs">
|
||||
{%- block breadcrumbs %}
|
||||
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home" aria-label="Home"></a></li>
|
||||
{%- for doc in parents %}
|
||||
<li class="breadcrumb-item"><a href="{{ doc.link|e }}">{{ doc.title }}</a></li>
|
||||
{%- endfor %}
|
||||
<li class="breadcrumb-item active">{{ title }}</li>
|
||||
{%- endblock %}
|
||||
{%- block breadcrumbs_aside %}
|
||||
{% block breadcrumbs %}
|
||||
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> »</li>
|
||||
{% for doc in parents %}
|
||||
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li>
|
||||
{% endfor %}
|
||||
<li>{{ title }}</li>
|
||||
{% endblock %}
|
||||
{% block breadcrumbs_aside %}
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
{%- if hasdoc(pagename) and display_vcs_links %}
|
||||
{%- if display_github %}
|
||||
{%- if check_meta and 'github_url' in meta %}
|
||||
{% if hasdoc(pagename) %}
|
||||
{% if display_github %}
|
||||
{% if check_meta and 'github_url' in meta %}
|
||||
<!-- User defined GitHub URL -->
|
||||
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||
{%- else %}
|
||||
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||
{%- endif %}
|
||||
{%- elif display_bitbucket %}
|
||||
{%- if check_meta and 'bitbucket_url' in meta %}
|
||||
{% else %}
|
||||
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||
{% endif %}
|
||||
{% elif display_bitbucket %}
|
||||
{% if check_meta and 'bitbucket_url' in meta %}
|
||||
<!-- User defined Bitbucket URL -->
|
||||
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||
{%- else %}
|
||||
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?mode={{ theme_vcs_pageview_mode or "view" }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||
{%- endif %}
|
||||
{%- elif display_gitlab %}
|
||||
{%- if check_meta and 'gitlab_url' in meta %}
|
||||
{% else %}
|
||||
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||
{% endif %}
|
||||
{% elif display_gitlab %}
|
||||
{% if check_meta and 'gitlab_url' in meta %}
|
||||
<!-- User defined GitLab URL -->
|
||||
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||
{%- else %}
|
||||
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||
{%- endif %}
|
||||
{%- elif show_source and source_url_prefix %}
|
||||
<a href="{{ source_url_prefix }}{{ pagename }}{{ page_source_suffix }}">{{ _('View page source') }}</a>
|
||||
{%- elif show_source and has_source and sourcename %}
|
||||
{% else %}
|
||||
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||
{% endif %}
|
||||
{% elif show_source and source_url_prefix %}
|
||||
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
|
||||
{% elif show_source and has_source and sourcename %}
|
||||
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
</li>
|
||||
{%- endblock %}
|
||||
{% endblock %}
|
||||
</ul>
|
||||
|
||||
{%- if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||
{#- Translators: This is an ARIA section label for sequential page links, such as previous and next page links. -#}
|
||||
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Sequential page navigation') }}">
|
||||
{%- if prev %}
|
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
{%- endif %}
|
||||
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
|
||||
{% if next %}
|
||||
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
{% endif %}
|
||||
{% if prev %}
|
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
{% endif %}
|
||||
</div>
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
<hr/>
|
||||
</div>
|
||||
@@ -1,62 +1,54 @@
|
||||
<footer>
|
||||
{%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||
{#- Translators: This is an ARIA section label for the footer section of the page. -#}
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
|
||||
{%- if prev %}
|
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
{%- endif %}
|
||||
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
{% if next %}
|
||||
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
|
||||
{% endif %}
|
||||
{% if prev %}
|
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
|
||||
{% endif %}
|
||||
</div>
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
{%- block contentinfo %}
|
||||
<p>
|
||||
{%- if show_copyright %}
|
||||
{%- if hasdoc('copyright') %}
|
||||
{%- trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
|
||||
{% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}{% endtrans %}
|
||||
{%- else %}
|
||||
{%- trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
|
||||
{% trans copyright=copyright|e %}© Copyright {{ copyright }}{% endtrans %}
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
{%- if build_id and build_url %}
|
||||
<span class="build">
|
||||
{#- Translators: Build is a noun, not a verb -#}
|
||||
{%- trans %}Build{% endtrans -%}
|
||||
<a href="{{ build_url }}">{{ build_id }}</a>.
|
||||
</span>
|
||||
{% trans build_url=build_url, build_id=build_id %}
|
||||
<span class="build">
|
||||
Build
|
||||
<a href="{{ build_url }}">{{ build_id }}</a>.
|
||||
</span>
|
||||
{% endtrans %}
|
||||
{%- elif commit %}
|
||||
<span class="commit">
|
||||
{#- Translators: the phrase "revision" comes from Git, referring to a commit #}
|
||||
{%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
|
||||
{% trans commit=commit %}
|
||||
<span class="commit">
|
||||
Revision <code>{{ commit }}</code>.
|
||||
</span>
|
||||
{% endtrans %}
|
||||
{%- elif last_updated %}
|
||||
<span class="lastupdated">
|
||||
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
|
||||
</span>
|
||||
{%- endif %}
|
||||
{%- if last_updated %}
|
||||
<span class="lastupdated">
|
||||
{%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
|
||||
</span>
|
||||
{%- endif -%}
|
||||
|
||||
</p>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
|
||||
{% if show_sphinx %}
|
||||
{%- set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
|
||||
{%- set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
|
||||
{#- Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
|
||||
{%- trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
|
||||
{#- Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documentation #}
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
|
||||
{#- Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #}
|
||||
{% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
|
||||
{% endif %}
|
||||
{%- if show_sphinx %}
|
||||
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
|
||||
{%- endif %}
|
||||
|
||||
{%- block extrafooter %} {% endblock %}
|
||||
|
||||
</footer>
|
||||
|
||||
+120
-131
@@ -8,77 +8,80 @@
|
||||
{%- endif %}
|
||||
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
|
||||
|
||||
{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
|
||||
{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%}
|
||||
{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="{{ lang_attr }}"{% if sphinx_version_info >= (7, 2) %} data-content_root="{{ content_root }}"{% endif %}>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
{%- if READTHEDOCS and not embedded %}
|
||||
<meta name="readthedocs-addons-api-version" content="1">
|
||||
{%- endif %}
|
||||
{{- metatags }}
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
{%- block htmltitle %}
|
||||
<meta charset="utf-8">
|
||||
{{ metatags }}
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
{% block htmltitle %}
|
||||
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
|
||||
{%- endblock -%}
|
||||
{% endblock %}
|
||||
|
||||
{#- CSS #}
|
||||
{%- for css_file in css_files %}
|
||||
{%- if css_file|attr("filename") %}
|
||||
{{ css_tag(css_file) }}
|
||||
{%- else %}
|
||||
<link rel="stylesheet" href="{{ pathto(css_file, 1)|escape }}" type="text/css" />
|
||||
{%- endif %}
|
||||
{%- endfor %}
|
||||
|
||||
{#
|
||||
"extra_css_files" is an undocumented Read the Docs theme specific option.
|
||||
There is no need to check for ``|attr("filename")`` here because it's always a string.
|
||||
Note that this option should be removed in favor of regular ``html_css_files``:
|
||||
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_css_files
|
||||
#}
|
||||
{%- for css_file in extra_css_files %}
|
||||
<link rel="stylesheet" href="{{ pathto(css_file, 1)|escape }}" type="text/css" />
|
||||
{%- endfor -%}
|
||||
|
||||
{#- FAVICON #}
|
||||
{%- if favicon_url %}
|
||||
<link rel="shortcut icon" href="{{ favicon_url }}"/>
|
||||
{%- endif %}
|
||||
|
||||
{#- CANONICAL URL (deprecated) #}
|
||||
{%- if theme_canonical_url and not pageurl %}
|
||||
{# FAVICON #}
|
||||
{% if favicon %}
|
||||
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
|
||||
{% endif %}
|
||||
{# CANONICAL URL #}
|
||||
{% if theme_canonical_url %}
|
||||
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
|
||||
{%- endif -%}
|
||||
{% endif %}
|
||||
|
||||
{#- CANONICAL URL #}
|
||||
{%- if pageurl %}
|
||||
<link rel="canonical" href="{{ pageurl|e }}" />
|
||||
{%- endif -%}
|
||||
|
||||
{#- JAVASCRIPTS #}
|
||||
{%- block scripts %}
|
||||
{# JAVASCRIPTS #}
|
||||
<script type="text/javascript" src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
|
||||
{%- if not embedded %}
|
||||
{%- for scriptfile in script_files %}
|
||||
{{ js_tag(scriptfile) }}
|
||||
{%- endfor %}
|
||||
<script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
|
||||
|
||||
{%- if READTHEDOCS or DEBUG %}
|
||||
<script src="{{ pathto('_static/js/versions.js', 1) }}"></script>
|
||||
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
|
||||
{% if sphinx_version >= "1.8.0" %}
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
|
||||
{%- for scriptfile in script_files %}
|
||||
{{ js_tag(scriptfile) }}
|
||||
{%- endfor %}
|
||||
{% else %}
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'{{ url_root }}',
|
||||
VERSION:'{{ release|e }}',
|
||||
LANGUAGE:'{{ language }}',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
|
||||
HAS_SOURCE: {{ has_source|lower }},
|
||||
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
|
||||
};
|
||||
</script>
|
||||
{%- for scriptfile in script_files %}
|
||||
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
|
||||
{%- endfor %}
|
||||
{% endif %}
|
||||
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
|
||||
{%- if not READTHEDOCS %}
|
||||
{%- if theme_analytics_id %}
|
||||
<script src="https://ssl.google-analytics.com/analytics.js" async id="ga"></script>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
{#- OPENSEARCH #}
|
||||
{# OPENSEARCH #}
|
||||
{%- if use_opensearch %}
|
||||
<link rel="search" type="application/opensearchdescription+xml"
|
||||
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
|
||||
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
|
||||
{# CSS #}
|
||||
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
|
||||
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
|
||||
{%- for css in css_files %}
|
||||
{%- if css|attr("rel") %}
|
||||
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
|
||||
{%- else %}
|
||||
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
|
||||
{%- endif %}
|
||||
{%- endfor %}
|
||||
|
||||
{%- for cssfile in extra_css_files %}
|
||||
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
||||
{%- endfor %}
|
||||
|
||||
{%- block linktags %}
|
||||
{%- if hasdoc('about') %}
|
||||
@@ -105,122 +108,108 @@
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
{%- block extrabody %} {% endblock %}
|
||||
{% block extrabody %} {% endblock %}
|
||||
<div class="wy-grid-for-nav">
|
||||
{#- SIDE NAV, TOGGLES ON MOBILE #}
|
||||
{# SIDE NAV, TOGGLES ON MOBILE #}
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
|
||||
{%- block sidebartitle %}
|
||||
{% block sidebartitle %}
|
||||
|
||||
{# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #}
|
||||
{# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #}
|
||||
{%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
|
||||
{%- set _root_doc = root_doc|default(master_doc) %}
|
||||
<a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}>
|
||||
{% if not theme_logo_only %}{{ project }}{% endif %}
|
||||
{%- if logo or logo_url %}
|
||||
<img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
|
||||
{%- endif %}
|
||||
{% if logo and theme_logo_only %}
|
||||
<a href="{{ pathto(master_doc) }}">
|
||||
{% else %}
|
||||
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
|
||||
{% endif %}
|
||||
|
||||
{% if logo %}
|
||||
{# Not strictly valid HTML, but it's the only way to display/scale
|
||||
it properly, without weird scripting or heaps of work
|
||||
#}
|
||||
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="Logo"/>
|
||||
{% endif %}
|
||||
</a>
|
||||
|
||||
{%- if READTHEDOCS or DEBUG %}
|
||||
{%- if theme_version_selector or theme_language_selector %}
|
||||
<div class="switch-menus">
|
||||
<div class="version-switch"></div>
|
||||
<div class="language-switch"></div>
|
||||
{% if theme_display_version %}
|
||||
{%- set nav_version = version %}
|
||||
{% if READTHEDOCS and current_version %}
|
||||
{%- set nav_version = current_version %}
|
||||
{% endif %}
|
||||
{% if nav_version %}
|
||||
<div class="version">
|
||||
{{ nav_version }}
|
||||
</div>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{%- include "searchbox.html" %}
|
||||
{% include "searchbox.html" %}
|
||||
|
||||
{%- endblock %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
|
||||
{%- block navigation %}
|
||||
{#- Translators: This is an ARIA section label for the main navigation menu -#}
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
|
||||
{%- block menu %}
|
||||
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
|
||||
collapse=theme_collapse_navigation|tobool,
|
||||
includehidden=theme_includehidden|tobool,
|
||||
titles_only=theme_titles_only|tobool) %}
|
||||
{%- if toctree %}
|
||||
{{ toctree }}
|
||||
{%- else %}
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
{% block menu %}
|
||||
{#
|
||||
The singlehtml builder doesn't handle this toctree call when the
|
||||
toctree is empty. Skip building this for now.
|
||||
#}
|
||||
{% if 'singlehtml' not in builder %}
|
||||
{% set global_toc = toctree(maxdepth=theme_navigation_depth|int,
|
||||
collapse=theme_collapse_navigation|tobool,
|
||||
includehidden=theme_includehidden|tobool,
|
||||
titles_only=theme_titles_only|tobool) %}
|
||||
{% endif %}
|
||||
{% if global_toc %}
|
||||
{{ global_toc }}
|
||||
{% else %}
|
||||
<!-- Local TOC -->
|
||||
<div class="local-toc">{{ toc }}</div>
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
||||
{#- Translators: This is an ARIA section label for the navigation menu that is visible when viewing the page on mobile devices -#}
|
||||
<nav class="wy-nav-top" aria-label="{{ _('Mobile navigation menu') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
|
||||
{%- block mobile_nav %}
|
||||
{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
{% block mobile_nav %}
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
|
||||
{%- endblock %}
|
||||
{% endblock %}
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
{%- block content %}
|
||||
{%- if theme_style_external_links|tobool %}
|
||||
{% if theme_style_external_links|tobool %}
|
||||
<div class="rst-content style-external-links">
|
||||
{%- else %}
|
||||
{% else %}
|
||||
<div class="rst-content">
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
{% include "breadcrumbs.html" %}
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
{%- block document %}
|
||||
<div itemprop="articleBody">
|
||||
{% block body %}{% endblock %}
|
||||
{% block body %}{% endblock %}
|
||||
</div>
|
||||
{%- if self.comments()|trim %}
|
||||
<div class="articleComments">
|
||||
{%- block comments %}{% endblock %}
|
||||
</div>
|
||||
{%- endif%}
|
||||
{% if self.comments()|trim %}
|
||||
<div class="articleComments">
|
||||
{% block comments %}{% endblock %}
|
||||
</div>
|
||||
{% endif%}
|
||||
</div>
|
||||
{%- endblock %}
|
||||
{% include "footer.html" %}
|
||||
</div>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
{% include "versions.html" -%}
|
||||
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
|
||||
});
|
||||
</script>
|
||||
|
||||
{#- Do not conflict with RTD insertion of analytics script #}
|
||||
{%- if not READTHEDOCS %}
|
||||
{%- if theme_analytics_id %}
|
||||
<!-- Theme Analytics -->
|
||||
<script async src="https://www.googletagmanager.com/gtag/js?id={{ theme_analytics_id }}"></script>
|
||||
<script>
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
|
||||
gtag('config', '{{ theme_analytics_id }}', {
|
||||
'anonymize_ip': {{ 'true' if theme_analytics_anonymize_ip|tobool else 'false' }},
|
||||
});
|
||||
</script>
|
||||
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
{%- include "versions.html" %}
|
||||
{%- block footer %} {% endblock %}
|
||||
|
||||
</body>
|
||||
|
||||
Binary file not shown.
@@ -1,206 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Benjamin Bach <benjaoming@gmail.com>, 2023
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Benjamin Bach <benjaoming@gmail.com>, 2023\n"
|
||||
"Language-Team: Danish (https://www.transifex.com/readthedocs/teams/101354/da/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: da\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#. This is an ARIA section label for page links, including previous/next page
|
||||
#. link and links to GitHub/GitLab/etc.
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:22
|
||||
msgid "Page navigation"
|
||||
msgstr "Navigation"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Ret på GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Ret på Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Ret på GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr "Vis sidekilde"
|
||||
|
||||
#. This is an ARIA section label for sequential page links, such as previous
|
||||
#. and next page links.
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:67
|
||||
msgid "Sequential page navigation"
|
||||
msgstr "Sekventiel navigation"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr "Forrige"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr "Næste"
|
||||
|
||||
#. This is an ARIA section label for the footer section of the page.
|
||||
#: sphinx_rtd_theme/footer.html:4
|
||||
msgid "Footer"
|
||||
msgstr "Sidefod"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:21
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:23
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr "© Copyright %(copyright)s."
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr "Build"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:36
|
||||
msgid "Revision"
|
||||
msgstr "Version"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Last updated on %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Baseret på %(sphinx_web)s med et"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documentation
|
||||
#: sphinx_rtd_theme/footer.html:55
|
||||
msgid "theme"
|
||||
msgstr "tema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "udviklet af%(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Søg i %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr "Om disse dokumenter"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr "Indeks"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Søg"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr "Copyright"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#. This is an ARIA section label for the main navigation menu
|
||||
#: sphinx_rtd_theme/layout.html:166
|
||||
msgid "Navigation menu"
|
||||
msgstr "Navigation"
|
||||
|
||||
#. This is an ARIA section label for the navigation menu that is visible when
|
||||
#. viewing the page on mobile devices
|
||||
#: sphinx_rtd_theme/layout.html:188
|
||||
msgid "Mobile navigation menu"
|
||||
msgstr "Mobil navigation"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Venligst aktivér JavaScript for at anvende søgefunktionen"
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Søgeresultater"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Din søgning matchede ingen dokumenter. Tjek at alle ord er stavet korrekt og"
|
||||
" at du har valgt tilstrækkeligt med kategorier."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Søg i dokumentation"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versioner"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Downloads"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "På Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Projektets startside"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Builds"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Dokumentation"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Gratis hosting af dokumentation leveret af"
|
||||
|
||||
#~ msgid "Documentation Home"
|
||||
#~ msgstr "Dokumentationens startside"
|
||||
|
||||
#~ msgid "Breadcrumbs"
|
||||
#~ msgstr "Sti"
|
||||
|
||||
#~ msgid "Main"
|
||||
#~ msgstr "Primær"
|
||||
|
||||
#~ msgid "Top"
|
||||
#~ msgstr "Top"
|
||||
Binary file not shown.
@@ -1,136 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Tom Kunze <transifex.com@tomabrafix.de>, 2019
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Tom Kunze <transifex.com@tomabrafix.de>, 2019\n"
|
||||
"Language-Team: German (https://www.transifex.com/readthedocs/teams/101354/de/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: de\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Auf GitHub bearbeiten"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Auf Bitbucket bearbeiten"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Auf GitLab bearbeiten"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr "Quelltext anzeigen"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr "Zurück"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr "Weiter"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr "Build"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Zuletzt aktualisiert am %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Erstellt mit %(sphinx_web)s mit einem"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "bereitgestellt von %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "%(docstitle)s durchsuchen"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr "Über diese Dokumentation"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr "Index"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Suche"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr "Copyright"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Bitte aktiviere JavaScript, um die Suchfunktion zu nutzen."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Suchergebnisse"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Es wurden keine mit deiner Suchanfrage übereinstimmenden Dokumente gefunden."
|
||||
" Achte darauf, dass alle Wörter richtig geschrieben sind und dass genug "
|
||||
"Kategorien ausgewählt sind."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Dokumentation durchsuchen"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versionen"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "Auf Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Projektübersicht"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Builds"
|
||||
Binary file not shown.
@@ -1,201 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 15:43-0600\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.11.0\n"
|
||||
|
||||
#. This is an ARIA section label for page links, including previous/next page
|
||||
#. link and links to GitHub/GitLab/etc.
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:22
|
||||
msgid "Page navigation"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr ""
|
||||
|
||||
#. This is an ARIA section label for sequential page links, such as previous
|
||||
#. and next page links.
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:67
|
||||
msgid "Sequential page navigation"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr ""
|
||||
|
||||
#. This is an ARIA section label for the footer section of the page.
|
||||
#: sphinx_rtd_theme/footer.html:4
|
||||
msgid "Footer"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:21
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:23
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr ""
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr ""
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:36
|
||||
msgid "Revision"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr ""
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr ""
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documentation
|
||||
#: sphinx_rtd_theme/footer.html:55
|
||||
msgid "theme"
|
||||
msgstr ""
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr ""
|
||||
|
||||
#. This is an ARIA section label for the main navigation menu
|
||||
#: sphinx_rtd_theme/layout.html:166
|
||||
msgid "Navigation menu"
|
||||
msgstr ""
|
||||
|
||||
#. This is an ARIA section label for the navigation menu that is visible when
|
||||
#. viewing the page on mobile devices
|
||||
#: sphinx_rtd_theme/layout.html:188
|
||||
msgid "Mobile navigation menu"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words "
|
||||
"are spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr ""
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr ""
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Documentation Home"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Breadcrumbs"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Main"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Top"
|
||||
#~ msgstr ""
|
||||
|
||||
Binary file not shown.
@@ -1,169 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2019
|
||||
# Radina Matic <radina.matic@gmail.com>, 2021
|
||||
# Leonardo J. Caballero G. <leonardocaballero@gmail.com>, 2022
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Leonardo J. Caballero G. <leonardocaballero@gmail.com>, 2022\n"
|
||||
"Language-Team: Spanish (https://www.transifex.com/readthedocs/teams/101354/es/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: es\n"
|
||||
"Plural-Forms: nplurals=3; plural=n == 1 ? 0 : n != 0 && n % 1000000 == 0 ? 1 : 2;\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Editar en GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Editar en Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Editar en GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr "Ver código fuente de la página"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr "Anterior"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr "Siguiente"
|
||||
|
||||
#. This is an ARIA section label for the footer section of the page.
|
||||
#: sphinx_rtd_theme/footer.html:4
|
||||
msgid "Footer"
|
||||
msgstr "Pie de página"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:21
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr "© <a href=\"%(path)s\">Derechos de autor</a> %(copyright)s."
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:23
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr "© Derechos de autor %(copyright)s."
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr "Compilación"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:36
|
||||
msgid "Revision"
|
||||
msgstr "Revisión"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Actualizado por última vez el %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Compilado con %(sphinx_web)s usando un"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documentation
|
||||
#: sphinx_rtd_theme/footer.html:55
|
||||
msgid "theme"
|
||||
msgstr "tema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "proporcionado por %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Buscar en %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr "Sobre esta documentación"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr "Índice"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Búsqueda"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr "Derechos de autor"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr "Logotipo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
"Por favor, active JavaScript para habilitar la funcionalidad de búsqueda."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Resultados de la búsqueda"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Su búsqueda no coincide con ningún documento. Por favor, asegúrese de que "
|
||||
"todas las palabras estén correctamente escritas y que usted haya "
|
||||
"seleccionado las suficientes categorías."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Buscar documentos"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versiones"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Descargas"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "En Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Página de Proyecto"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Compilaciones"
|
||||
Binary file not shown.
@@ -1,166 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2020
|
||||
# Ivar Smolin <okul@linux.ee>, 2021
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Ivar Smolin <okul@linux.ee>, 2021\n"
|
||||
"Language-Team: Estonian (https://www.transifex.com/readthedocs/teams/101354/et/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: et\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Muuda GitHubis"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Muuda Bitbucketis"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Muuda GitLabis"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr "Vaata lehe lähtekoodi"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr "Eelmine"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr "Järgmine"
|
||||
|
||||
#. This is an ARIA section label for the footer section of the page.
|
||||
#: sphinx_rtd_theme/footer.html:4
|
||||
msgid "Footer"
|
||||
msgstr "Jalus"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:21
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr "© <a href=\"%(path)s\">Autoriõigus</a> %(copyright)s."
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:23
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr "© Autoriõigus %(copyright)s."
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr "Ehitus"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:36
|
||||
msgid "Revision"
|
||||
msgstr "Redaktsioon"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Viimati uuendatud %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Ehitatud %(sphinx_web)s'iga,"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documentation
|
||||
#: sphinx_rtd_theme/footer.html:55
|
||||
msgid "theme"
|
||||
msgstr "kujundusteema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "on loonud %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Otsi dokumendist %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr "Nende dokumentide kirjeldused"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr "Indeks"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Otsing"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr "Autoriõigus"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Otsimisfunktsiooni lubamiseks aktiveeri palun JavaScript"
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Otsingu tulemused"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Sinu otsingule ei vastanud ükski dokument. Palun veendu, et kõik sisestatud "
|
||||
"sõnad on õigesti kirjutatud ja sa oled valikud piisaval hulgal kategooriaid."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Otsi dokumente"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versioonid"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Allalaadimised"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "Saidil Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Projekti kodu"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Ehitused"
|
||||
Binary file not shown.
@@ -1,161 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2021
|
||||
# Peyman M., 2022
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Peyman M., 2022\n"
|
||||
"Language-Team: Persian (Iran) (https://www.transifex.com/readthedocs/teams/101354/fa_IR/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: fa_IR\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "ویرایش در GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "ویرایش در Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "ویرایش در GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr "نمایش متن منبع صفحه"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr "پیشین"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr "بعدی"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:21
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr "© <a href=\"%(path)s\">حق انتشار</a> %(copyright)s."
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:23
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr "© حق انتشار%(copyright)s."
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr "ساخت"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:36
|
||||
msgid "Revision"
|
||||
msgstr "بازبینی"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "آخرین بروز رسانی در %(last_updated)s ."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "ساخته شده با %(sphinx_web)s"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documentation
|
||||
#: sphinx_rtd_theme/footer.html:55
|
||||
msgid "theme"
|
||||
msgstr "پوسته"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "تهیّه شده با %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "جستجو در %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr "درباره این مستندات"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr "فهرست"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "جستجوی"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr "کپی رایت"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr "آرم"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "لطفاً جاوا اسکریپت را فعّال کنید تا قابلیّت جستجو فعّال شود."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "نتایج جستجو"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"جستجوی شما با هیچ سندی مطابقت نداشت. لطفاً از درستی املای واژگان مطمئن شوید."
|
||||
" همچنین بررسی کنید آیا به اندازه کافی دسته بندی انتخاب کردهاید."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "جستجوی مستندات"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "نگارشها"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "بارگیریها"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "دربارهی خواندن مستندات"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "صفحه خانگی پروژه"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "ساختها"
|
||||
Binary file not shown.
@@ -1,169 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2020
|
||||
# Radina Matic <radina.matic@gmail.com>, 2021
|
||||
# Jérémie Tarot <silopolis@gmail.com>, 2023
|
||||
# CapitainFlam, 2023
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: CapitainFlam, 2023\n"
|
||||
"Language-Team: French (https://www.transifex.com/readthedocs/teams/101354/fr/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: fr\n"
|
||||
"Plural-Forms: nplurals=3; plural=(n == 0 || n == 1) ? 0 : n != 0 && n % 1000000 == 0 ? 1 : 2;\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Éditer sur GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Éditer sur Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Éditer sur GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
|
||||
msgid "View page source"
|
||||
msgstr "Afficher la source de la page"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
|
||||
msgid "Previous"
|
||||
msgstr "Précédent"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
|
||||
msgid "Next"
|
||||
msgstr "Suivant"
|
||||
|
||||
#. This is an ARIA section label for the footer section of the page.
|
||||
#: sphinx_rtd_theme/footer.html:4
|
||||
msgid "Footer"
|
||||
msgstr "Pied de page"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:21
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr "© <a href=\"%(path)s\">Droits d'auteur</a> %(copyright)s."
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:23
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr "© Droits d'auteur %(copyright)s."
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:30
|
||||
msgid "Build"
|
||||
msgstr "Compilation"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:36
|
||||
msgid "Revision"
|
||||
msgstr "Révision"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:41
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Dernière mise à jour le %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:53
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Compilé avec %(sphinx_web)s en utilisant un"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documentation
|
||||
#: sphinx_rtd_theme/footer.html:55
|
||||
msgid "theme"
|
||||
msgstr "thème"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:57
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "fourni par %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:97
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Rechercher dans %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:105
|
||||
msgid "About these documents"
|
||||
msgstr "À propos de cette documentation"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:108
|
||||
msgid "Index"
|
||||
msgstr "Index"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Rechercher"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:114
|
||||
msgid "Copyright"
|
||||
msgstr "Droits d'auteur"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:143
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Activez JavaScript pour accéder à la fonction de recherche."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Résultats de la recherche"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Votre recherche ne correspond à aucun document. Assurez-vous que tous les "
|
||||
"mots sont correctement orthographiés et que vous avez sélectionné "
|
||||
"suffisamment de catégories."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Rechercher docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versions"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Téléchargements"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "À propos de Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Accueil du projet"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Compilations"
|
||||
Binary file not shown.
@@ -1,23 +0,0 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Ivan Bratović, 2022
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2023-02-06 15:36+0100\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Ivan Bratović, 2022\n"
|
||||
"Language-Team: Croatian (https://www.transifex.com/readthedocs/teams/101354/hr/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.11.0\n"
|
||||
"Language: hr\n"
|
||||
"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n"
|
||||
Loaded 100 of 148 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user