Flake8: Your Tool For Style Guide Enforcement — flake8 7.0.0 documentation
Note It is very important to install Flake8 on the correct version of Python for your needs. If you want Flake8 to properly parse new language features in Python 3.5 (for example), you need it to be installed on 3.5 for Flake8 to understand those features. In many ways, Flake8 is tied to the version of Python on which it runs.
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
Read the Docs & Sphinx now support Commonmark
from recommonmark.parser import CommonMarkParser source_parsers = {'.md': CommonMarkParser} source_suffix = ['.rst', '.md'] This allows you to write both .md and .rst files inside of the same project. Example Project¶ You can see this in action in my sphinx-markdown-test repo on GitHub. You can also see a rendered version hosted on Read the Docs. How it works¶ The way this project works is that it
Google グループ
Google グループでは、オンライン フォーラムやメール ベースのグループを作成したり、こうしたフォーラムやグループに参加したりすることで、大勢のユーザーと情報の共有やディスカッションを行うことができます。
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
3.6.1. Restructured Text (reST) and Sphinx CheatSheet — openalea.doc v0.8.0 documentation
See also This documentation is based based upon documentation found in: Sphinx Docutils Note Sphinx code is written in reST. Nonetheless, sphinx adds many additional directives on top of the reST syntax. Therefore sphinx code may not be fully compatible with reST. 3.6.2.1. Introduction¶ reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It
sphinx-autobuildで再ビルド、ブラウザの再リロードの手間を省いてSphinx文書をサクサク作成 - Qiita
sphinx-autobuildで再ビルド、ブラウザの再リロードの手間を省いてSphinx文書をサクサク作成Sphinx 概要 本稿では、Sphinxドキュメントを保存するたびに自動的にビルド、ブラウザをリロードしてくれるツールsphinx-autobuildを紹介し、インストール方法や使い方を簡単に説明します。sphinx-autobuildを使うことで、再ビルド、ブラウザの再リロードの手間を省いて、より楽にSphinx文書を作成できます。 はじめに 最近Sphinxを使い始めました。手軽に文章を体系的にまとめることができ、またバージョン管理もしやすく便利に使っています。 しかし、HTML形式などでできあがったドキュメントを見るには、ビルドコマンドを実行しなければならないのが不便です。ブラウザで閲覧している場合、ページの更新も必要です。 そこで、sphinx-autobuildを導入しま
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
Python Livereload を使って Sphinx でドキュメントを書く - Qiita
Sphinx でドキュメントを書いているとソースファイル (reST) を HTML に変換するために make html コマンドを実行することが多いと思います。しばらく書いてみると、ソースファイルを変更する度にコマンドを実行して HTML を確認するためにブラウザをリロードして ... という操作は煩雑に思えてきます。 Python LiveReload を使うとファイルの変更を検知してブラウザを自動的にリロードできるようになります。設定スクリプトは Python で記述しますので、Python に関するドキュメントを書いている場合は頭の切り替えが要らない点がメリットと言えます。 バージョンによって設定方法が違っており、各種 API も変わっています。バージョン 2.2.1 からはそろそろ Python 3.x でも使えるようになってきましたので、導入方法をまとめておきます。 dire
表を書きたい — Sphinx逆引き辞典 v0.0.1 documentation
表を書きたい¶ 一番最初に説明されている–や+を使って書くグリッドテーブル方式は確かにテキストファイルを見たときに分かりやすいのですが、幅を合わせる必要があり、書くのが非常に大変です。特に日本語フォントが混じると文字数がずれることがあります。 CSVテーブルやListテーブルを使った方が楽です。 まずはcsvテーブルです。”,”で区切ることでテーブルを書きます。csv-table::と本文の間は一行空けます。これはlist-tableも同様です。 .. csv-table:: Frozen Delights! "Treat", "Quantity", "Description" "Albatross", 2.99, "On a stick!" "Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be crunchy, n
ブロック図生成ツール blockdiag — blockdiag 1.0 ドキュメント
ブロック図生成ツール blockdiag¶ blockdiag シリーズはシンプルなテキストからブロック図などの画像を生成する画像生成ツール群です。 blockdiag を用いると以下のような図が簡単に生成できます。 blockdiag の主な機能: 数種類の図に対応 ブロック図 (blockdiag コマンド) シーケンス図 (seqdiag コマンド) アクティビティ図 (actdiag コマンド) 論理ネットワーク図 (nwdiag コマンド) テキストベースの定義ファイルから画像ファイルを生成 (graphviz 風の文法を採用) 定義にあわせて図の配置を自動的に決定 (自動レイアウト) Sphinx, Trac, Redmine, 各種 Wiki エンジン等、多様なシステムへの画像埋め込みに対応 Enjoy documentation with blockdiag !
Sphinx 文書に markdown フォーマットを利用する - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 19日目です。 markdown と Sphinx (reST) Sphinx では文書を書く際の記述フォーマットに reStructured Text を利用していますが、 世を広く見回すと、github 然り、bitbucket 然り、様々な場所で markdown フォーマットが利用されています。 markdown フォーマットは reST と比べると表現力が低い上、表現を拡張することができないという点が指摘されています。 表現を拡張することができないため、いくつかの方言が存在するという問題もあります。 ですが、reST と比べてシンプルで、なおかつポピュラーに利用されているフォーマットであるため、 新しく Sphinx に触り始める人の取っ掛かりとしては、markdown はうってつけのフォーマットと言えます。 sphinxcont
ドキュメンテーションツール「Sphinx」をチーム運用するまでの道のり - Librabuch | sphinx_documentation_advent_calendar_2013
本エントリは、次のAdvent Calendarのために書かれたものです。 ドキュメンテーション Advent Calendar 2013 （12月15日） 取り扱う内容 株式会社ALBERTのシステム開発部では、ドキュメンテーションツールであるSphinxを積極的に活用しています。 Sphinxの導入、利用そのものは簡易に行うことができるのですが、開発部でチームとして運用するためにはいくつかの困難がありました。 そんな幾重にも張り巡らされた困難を乗り越えて、2013年11月頃から本格的に運用が出来ているなぁ、と実感するに至ったので、今回は2013年の総決算としてその変遷を綴ります。 関連資料 Pythonプロダクトを活用した開発チーム運営 in PyCon APAC 2013 - SlideShare SphinxをMarkdownで使い隊 - SlideShare Sphinxとわたし
Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
sphinxでplantumlの図入り日本語テキストをlatexpdfjaでPDF化してみた - Qiita
2014-05-24 18:40頃追記 @hnakamur2 plantuml_latex_output_format で eps か pdf を指定すれば上手く行くかもしれません。 https://t.co/VuY328ZAIF — Yuya Nishihara (@yujauja) 2014, 5月 24 というご指摘を頂いて試したら、epsにしてみたらあっさり出来ました。ありがとうございます！ ということで下記は適宜編集しました。 rst2pdfを使って変換する方法はsphinx, rst2pdf, plantumlでUMLのクラス図入り本文日本語テキストをpdfに変換してみた - Qiitaに書きました。 Sphinx で日本語を含む PDF 出力をする - 憧れ駆動開発 SphinxでPDFファイル作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
sphinxcontrib-plantuml
Verified details These details have been verified by PyPI Maintainers yuja Unverified details These details have not been verified by PyPI Project links Homepage Download GitHub Statistics Installation pip install sphinxcontrib-plantuml Usage Add sphinxcontrib.plantuml to your extensions list in your conf.py: extensions = [ 'sphinxcontrib.plantuml', ] You may also need to specify the plantuml comm
Sphinx documentation on GitHub
The Data Desk often publishes documentation alongside its code on GitHub, a social networking site where developers share their work. GitHub’s main service — free for open-source projects — is for managing source code, but it also provides ticket tracking, wikis and a simple file-hosting service for publishing HTML pages. It’s that last trick that’s great for documentati
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Making PDFs from Markdown on Readthedocs.org using sphinx
Markdown Documentation with Sphinx | When Penguins Can Fly…
Publishing sphinx-generated docs on github — sphinxdoc-test v0.1 documentation