化学系のための Sphinx の文章作成マニュアル — 化学系のためのsphinxのquickチュートリアル 3.0 ドキュメント化学系のための Sphinx の文章作成マニュアル¶ 要旨： この文章はIT系の文章作成のデフォルトツールとなりつつある Sphinx を紹介する。 基本的には、 ubuntu を使用することを想定している。
sphinx, jsdoc, esdoc, typedocをdockerを使ってjavascriptのapiドキュメントを作ってみたメモ - Qiita
はじめに 気になっていたドキュメント作成ツールを試してみた。 作って比較した感想は以下。 sphinx:かなり奇麗なドキュメントを作成してくれる。rstは不馴れなのでmarkdown jsdoc: 寂しい。簡単 jsdoc-minami: jsdocに少しの手間で見た目がかなり良くなる。es5が混じるならこれかな。 esdoc: es6でクラスを作るならこれがきれい。カバレッジがデフォルトなのもよさそう。jsdocほどの自由さはないので、古い記法が混じったりすると使いにくいかも。 jsdoc-sphinx: そこそこの見た目とsphinxの統一感。rstファイルが出力されるので最後に編集できる。テンプレートが英語なので日本語で使うなら書き換えたほうがよいかも。 sphinx-js: 見た目は一番好み。sphinxのautodocをjsで使えるようにしたもの。sphinx-apidocがja
SphinxドキュメントをDockerでビルドする
先日GitHubで嬉しいアップデートが行われ、 masterリポジトリの/docs以下をGitHub Pagesで公開できるようになりました。 これまでGitHub Pagesを利用するにはgh-pagesブランチを作成する必要がありましたが、プロジェクトのソースコードと一緒にドキュメントを管理できようになったのはかなり嬉しいです！ そこで今回は、以前書いたAndroidアプリをDockerでビルドする記事をもとに ドキュメント生成ツールであるSphinxのビルドをDockerでやってみました。 これでプロジェクト用のドキュメントを作ってじゃんじゃん公開していきましょう。 Sphinxとは SphinxはPython製のドキュメント生成ツールです。 ドキュメント生成ツールとしてはかなり有名でして、Pythonの公式ドキュメントでも利用されています。 基本的なドキュメント作成の流れとしては、
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
ドキュメントシステムはこれを使え2015年版
12. 思いつくキーワードを挙げてみた POD Javadoc など WEB Sphinx Re:VIEW EWB CAS-UB Atlas Gitbook PressBooks Booktype IGP digital publisher BCCKS でんでんコン バータ Markdown Wiki 記法 reStructuredText RD、RDoc AsciiDoc HTMLBook DocBook DITA、JATS LATEX とか Docutils Calibre Pandoc Word（MS Office） Writer（LibreOffice） Adobe InDesign Adobe FrameMaker AH Formatter Prince Apache FOP Vivliostyle TEX エンジン ブラウザエンジン CSS Books cl-typesetting +
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
GradleでSphinxをビルドしてみた。 - しおしお
お仕事でSphinxでドキュメント書いてて、Gradleでビルドしてるときたら、SphinxもGradleからビルドしないとダメだよねってことでやってみた。 お試しプロジェクトの構成はこんな感じで、プロジェクト直下のdocディレクトリにドキュメントが格納されていると。 まずは、Execタスクを使ってビルドをしてみたけど、なんか普通すぎてつまらない。 Execタスクのドキュメント→Exec - Gradle DSL Version 1.0-rc-3 task buildDoc(type : Exec) { workingDir 'doc' commandLine 'make', 'html' } あまりにもつまらなすぎたので、Sphinx用のタスクを作ったりしてみました。 Sphinxタスクの使い方やソースはこちら→siosio/Sphinx-GradlePlugin · GitHub Sp
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
AWS Lambda で Sphinx
bitbucketの使い方