Quick reStructuredText
Quick reStructuredText https://docutils.sourceforge.io/docs/user/rst/quickref.html Being a cheat-sheet for reStructuredText Updated $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $ Copyright: This document has been placed in the public domain. The full details of the markup may be found on the reStructuredText page. This document is just intended as a reminder. Links that look like "(details)
【全自動】SphinxドキュメントをNetlifyでホスティングする - Qiita
はーい！毎週金曜日は Friday I/O ですよー。 株式会社ワムウでは、毎週金曜日は 興味がある事柄に取り組み、その成果を何らかの形でアウトプットする日 としております。 はじめに 今回は Sphinx で生成したドキュメントを Netlify でビルド & ホスティングする方法をご紹介いたしますー。 Sphinxとは reStructuredText っていう Markdown みたいなもんで綺麗なドキュメントが作れますよってヤツです。 PDF とかも吐けるみたい。 Netlifyとは HTMLをむちゃくちゃ簡単にホスティングしてくれるお方です。 Githubと連携してプッシュ時に自動でデプロイ・ビルド・ホスティングまでしてくれます。 ドキュメントを用意する とか言われてもだるいと思うので、サンプルプロジェクト用意しときました！ ファイル構成は以下のとおり。 root |- docs
Exceltable — Exceltable 0.2.2 documentation
Exceltable¶ Module sphinxcontrib.exceltable is an extension for Sphinx, that adds support for including spreadsheets, or part of them, into Sphinx document. It has been tested to run on both Python 2.7 and 3.4 This is document describes how to install, use and contribute to the development of the sphinxcontrib.exceltable module. Setup¶ Here you can find the minimum steps for installation and usage
Sphinx extensions for embedded plots, math and more — sampledoc 1.0 documentation
Sphinx extensions for embedded plots, math and more¶ Sphinx is written in python, and supports the ability to write custom extensions. We’ve written a few for the matplotlib documentation, some of which are part of matplotlib itself in the matplotlib.sphinxext module, some of which are included only in the sphinx doc directory, and there are other extensions written by other groups, eg numpy and i
(6日目) Sphinx 拡張の紹介 - Hack like a rolling stone
Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
SphinxとIPython | Code Craft House
SphinxでIPythonのノートを取り込むようにすると、色々試した記録を後から見返すのに非常に便利です。この１年は、自分向けの技術メモなんかは、全てSphinxで管理していました。おかげで公開ページ(こっちはwordpress)の更新が盛大にストップしていましたが…。今日はそんな便利なSphinxとの連携の小技を紹介します。 IPythonについて IPythonは、インタラクティブにPythonを実行するためのツールです。ブラウザでコードを書きながら実行することができ、作成したグラフなんかもノートに含めることができます。 http://ipython.org 最近は人工知能や機械学習、ディープラーニングといったあたりの勉強をしていて、実行したコードや結果データグラフをそのまま残しておけるのですごく便利です。最近はコマンドラインからpythonを立ち上げることがめっきり減りました。また
The Power of Sphinx: Integrating Jinja with RST
The Power of Sphinx: Integrating Jinja with RST¶ Sphinx is a super powerful tool. This has its upsides and downsides. One of the major downsides is that historically it has been built as a framework that allows users to do just about anything. This is great, except it also means that a lot of the specific value out of the modular design hasn’t been documented or made explicit to users. I’m hoping
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinx-jinja
GitHub - foremast/foremast: Spinnaker Pipeline/Infrastructure Configuration and Templating Tool - Pipelines as Code.
GitHub - sphinx-gallery/sphinx-gallery: Sphinx extension for automatic generation of an example gallery
GitHub - jupyter/jupyter-sphinx-theme: A Sphinx theme for Jupyter and IPython documentation
GitHub - Chilipp/sphinx-nbexamples: ⛔️ Deprecated: Create an examples gallery with sphinx from Jupyter Notebooks
Jupyter Notebook Tools for Sphinx — nbsphinx version 0.2.10
flat-table — LinuxDoc 20160723 documentation
kernel-doc HOWTO — kernel-doc HOWTO 4.7.0 documentation
Welcome to The Linux Kernel’s documentation! — The Linux Kernel 4.8 documentation
Latest Tech & Business News, Reviews and Tricks
GitHub - readthedocs/sphinx-autoapi: A new approach to API documentation in Sphinx.
Writing Documentation for Flake8 — flake8 7.0.0 documentation
GitHub - tardyp/sphinx-jinja