GitHub - wpilibsuite/sphinxext-remoteliteralinclude: Extends literalinclude to include URLs

Extends literalinclude to include URLs. Contribute to wpilibsuite/sphinxext-remoteliteralinclude development by creating an account on GitHub.

https://github.com/wpilibsuite/sphinxext-remoteliteralinclude

旧 MinTriangle リポジトリを作り直し。

d3d11 samples ドキュメント

http://ousttrue.github.io/d3d11_samples/

MyST なかなかよい

reStructuredText わりと苦手なので sphinx でも Markdown を使いたい派なのだが、 MyST なる Sphinx 向け markdown 拡張ができていた。

• Sphinx で使える Markdown 方言 ‘MyST’

sphinx directive の指定の仕方がシンプルで下のような感じ。markdown のシンタックスハイライトやフォーマッターに乗れるのでよい。

```{image} ./basic_pipeline.jpg
:width: 320px
:height: 320px
```

```{toctree}
basic/create_window
basic/create_device
basic/create_swapchain
basic/render_target
basic/compile_shader
basic/basic_pipeline
```

sphinx-autobuild と github-actions による gh-pages デプロイを仕込んだらかなりよくなった。

memo

• https://github.com/wpilibsuite/sphinxext-remoteliteralinclude

git の revision と path 指定して include できないかしら。 サンプルコードにちょこちょこっと解説を書きたいのだが、サンプルコードが進化する場合に literalinclude だと場所がずれるのだ。