Skip to content

Instantly share code, notes, and snippets.

Takeshi KOMIYA tk0miya

View GitHub Profile
View layout.html
{% extends "!layout.html" %}
{% block content %}
<div class="notice" style="width: 100%; height: 24px; background-color: #ffe761; padding: 8px 20px 8px 20px;">
このページは新しめのやつなので気をつけておくれやす。 っ[ぶぶづけ]
</div>
{{ super() }}
{% endblock %}
View 0001-doc-Fix-messages-in-extensions-are-not-translated.patch
From 551ad9efa5cc60a50e6f280e9aecdd12220693f1 Mon Sep 17 00:00:00 2001
From: Takeshi KOMIYA <i.tkomiya@gmail.com>
Date: Mon, 16 Mar 2020 00:38:21 +0900
Subject: [PATCH] doc: Fix messages in extensions are not translated
So far, custom extensions for python-doc have accessed internal data
structure of sphinx.locale module directly. But, it does not work at
present because the structure has changed since Sphinx-1.8 release.
This uses public translation APIs of Sphinx instead to get translated
messages.
View conf.py
latex_elements = {
'extrapackages': r'\usepackage{titlesec}',
'preamble': '\n'.join([
# 字下げ (なんでデフォルトで動かないんだろ?)
r'\setlength{\parindent}{1zw}',
# 段落調整、箇条書きの行間調整
r'\setlength{\parskip}{0ex}',
# 見出しの装飾
# ref: https://qiita.com/krtx/items/deeec0843caf37b66054
r'\definecolor{teal}{RGB}{0,128,128}',
View README
preface and appendix for Sphinx
View ext.py
"""
autodoc: show default value of arguments as is
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:license: Same as Sphinx
"""
import ast
import inspect
from typing import Any, Dict
View rendered.md
`````
CommonMark では fenced code block の終了は、開始マーカーと同じかそれ以上の backtick を必要とします。
```
ですので、まだここはコードブロックの中です。
``````````
そして、ここはコードブロックの外です。
また、fenced code block は backtick か tilde をマーカーに利用できると定義されているので
~~~
ここはコードブロックですし
View ext.py
# extension testbed
# autodoc_typehints_docinfo -- typehint をいい感じに表示する拡張
#
# * 型情報は typehint を書いておいてね
# * conf.py で autodoc_typehints = 'docinfo' と設定する
from docutils import nodes
from sphinx import addnodes
from sphinx.util.docfields import DocFieldTransformer
from sphinx.util.inspect import Signature
View ext.py
# extension testbed
# Description: ``:index:`` ロールのタイトルを強調表示する
from docutils import nodes
from sphinx import addnodes
from sphinx.transforms import SphinxTransform
class IndexStyleTransform(SphinxTransform):
default_priority = 200
View README.rst

Sphinx でも絵文字を使ってみたい

github っぽく emoji を使ってみたいので、 GitHub の emoji ライブラリ gemoji から絵文字の定義リストを拝借して Sphinx に突っ込んで見るテスト。substitution 文法を拝借したので |+1| とすると絵文字が出ます。

Unicode の文字をそのまま埋め込んでいるので、PDF 出力する場合は Unicode 対応の LaTeX エンジンといい感じのフォントを使ってください。 つまり、デフォルトでは動作しません。

使い方

View .gitlab-ci.yml
image: tk0miya/sphinx-pdf
pages:
script:
- kanji-config-updmap-sys ipaex
- make epub html latexpdf
- mkdir build/html/files
- mv build/latex/docutils.pdf build/html/files/mastering_docutils-v1.0.pdf
- mv build/epub/docutils.epub build/html/files/mastering_docutils-v1.0.epub
- mv build/html/ docutils
- zip -r docutils.zip docutils/
You can’t perform that action at this time.