Skip to content

Add the sphinx-toolbox extension #19

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add the sphinx-toolbox extension #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc7ffac
docs: update readme, maintaners, etc
NickVolynkin Feb 21, 2023
de73ccd
dev: add sphinx-toolbox extension
NickVolynkin Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.git
.idea
.git
.github
.gitignore
.dockerignore
README.md
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FROM python:3.8-slim

LABEL maintainer="Artem Morozov <[email protected]>"
LABEL maintainer=""

SHELL ["/bin/bash", "-o", "pipefail", "-c"]

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile-slim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FROM python:3.8-slim

LABEL maintainer="Artem Morozov <[email protected]>"
LABEL maintainer=""

COPY requirements.txt /tmp/requirements.txt

Expand Down
34 changes: 25 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,38 @@ docker run --rm -it -v $(pwd):/doc tarantool/doc-builder sh -c "make <doc>"

## What's on board:

- sphinx 1.8.5
- texlive
- graphviz
- sphinx-intl
- docutils
- sphinxcontrib-svg2pdfconverter
- Sphinx 4.3.1
- Some image processing tools:

- graphviz
- dvisvgm
- imagemagick
- sphinxcontrib-svg2pdfconverter

- Sphinx themes and plugins:

- sphinx-rtd-theme
- pydata-sphinx-theme
- ablog
- pygments-graphql
- sphinx-intl and polib for localization
- recommonmark for Markdown support

Tools for building and deploying docs:

- sphinx-autobuild
- curl
- cmake
- awscli
- pandoc
- panflute
- dvisvgm

## Version history

### Unreleased

### 4.3

* Add the [sphinx-toolbox](https://sphinx-toolbox.readthedocs.io) extension.

### 4.2

* Add recommonmark and sphinx-rtd-theme
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ pygments-graphql==1.0.0
sphinx-panels==0.6.0
recommonmark==0.7.1
sphinx-rtd-theme==1.0.0
sphinx-toolbox==3.4.0