【コスト削減約30％以上】AsciiDocとGitHubでPDF、HTMLマニュアルのデータを部署をまたいで一元管理 | 事例 | 株式会社ヒューマンサイエンス
【コスト削減約30％以上】AsciiDocとGitHubでPDF、HTMLマニュアルのデータを部署をまたいで一元管理 ヤマハ株式会社様 ヤマハ株式会社グループ 概要 ・設立：1897年10月 ・資本金：285億34百万円 ・従業員数： 連結 20,175人 ・事業内容： 楽器事業、音響機器事業、部品・装置事業 ご利用サービス ・マニュアル作成 ・翻訳 ・AsciidocとGitHubを利用したドキュメント編集＆管理システム構築 導入したマニュアル作成フロー 通常のドキュメントの制作フローで使うシステムやツール類を、各種オープンソースソフトウェア（ATOM/RedPen）やGitHub、SourceTreeなどIT分野に馴染みのあるツール類に代替しました。 各工程のデモ動画 1. テキストエディタATOMでAsciiDocを編集し、GitHubでデータを管理する手順です。 2. AsciiD
MkDocs
MkDocs Project documentation with Markdown. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
プロジェクトを作る
プロジェクトを作る¶ Sphinxでドキュメントを作成するためには、まず「プロジェクト」を作る必要があります。プロジェクトはコマンドラインで作成しますので、Windowsの場合はコマンドプロンプト、MacやLinuxの場合はTerminal(仮想端末)を起動させます。 プロジェクトは、いくつかの設定ファイルなどが配置された、ドキュメントを保存するための専用ディレクトリです。配置するファイルなどは、Sphinxに含まれる「sphinx-quickstart」というコマンドで作成します。 sphinx-quickstart¶ 何もオプションを付けないと対話モードになり、 -q オプションを付けると非対話モードでプロジェクトが作成できます。ここでは非対話モードを紹介します。 プロジェクト名の指定: -p ドキュメントの製作者(Author name(s))の指定: -a プロジェクトのバージョン
Pandoc+MarkdownでLaTeXとSphinx(reStructuredText)を操る。 - Programming Log
2014-01-20 Pandoc+MarkdownでLaTeXとSphinx(reStructuredText)を操る。 Macソフトウェア導入 Sphinx LaTeX はじめに 最近LaTeXでレポートや論文を作るときに，Markdownで書いてからLaTeXに変換するのが流行ってるらしいです。 Markdownとは？ このブログを始めた時に知ったマークアップ言語。このブログもMarkdownで書いてる。 書きやすいし読みやすくてもう手放せない。GitHubのREADMEとかにも使われてる。 Sphinxとは reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で書かれたファイルから美しいドキュメントを簡単に生成することができる。Sphinx公式サイトやPythonのドキュメントもSphinxで書かれていることで有名。 これは僕も以前に使った事があるけど，
ReadTheDocsでSphinxホスティングは磐石（になる予定） - YAMAGUCHI::weblog
はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。最近PHP界隈でも人気の高いドキュメント生成ツールSphinxですが、みなさん楽しいSphinxライフを送っていますでしょうか。さて、Sphinxでドキュメントを作った場合、一番キャッチーなのはHTMLだと思うんですが、そのホスティングはみなさんどうされていますか？ Sphinx-Users.jpにいくつかホスティングの方法を紹介してありますが、今日は割と新しいホスティング方法のReadTheDocsをご紹介します。 ReadTheDocsってなに？ Home | Read the Docs rtfd/readthedocs.org · GitHub ReadTheDocsは2010年のDjango Dashで作成されたコードを元に公開されているサービス/ライブラリです。外部に公開されているSphinxのレポジトリ（G
ドキュメントシステムはこれを使え2015年版
Sphinx Con JP 2015での発表 目的からドキュメントシステムを選べるYes/Noチャートは33ページにあります。 （当初アップロードしたものはこのページにミスがあったので差し替えています。高橋さんありがとうございます。）Read less
実務に使うプレーンテキスト→Microsoft Word変換、あるいはPandocを使い始めた話 - 技術memo
SIerのお仕事で、設計書を書いたりするときに、Microsoft Office Wordのdocxファイルを使うことがあります。 そんな中でも、ドキュメントのフォーマットがある程度自由にできる場合に*1、Wordで直接書くのをやめて、プレーンテキスト(Markdown)で書いて、Pandocというツールでdocxファイルに変換するようにしてみた、という話です。 動機 何故Wordに直接書くのを止めるのか、という話はいくらでも先例がありそうですが、個人的には以下のあたりが大きいです。 Git等のバージョン管理ツールを使うので、差分が取りやすい形式がよい Wordの入力機能が時々お節介でうざったい、いちいち設定で無効化するのも面倒 GUIであちこちクリックしながら入力したくない、Emacs(またはあなたの好きなエディタ)を使いたい Pandocについて Pandoc - About pand
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://sphinx-users.jp/cookbook/pdf/
Build process overview
ReadTheDocs themeとMarkdown – 我的備忘録
Publishing sphinx-generated docs on github — sphinxdoc-test v0.1 documentation
Sphinx doc publishing workflow · Issue #28 · deis/deis
Sphinx のドキュメントを Travis CI でビルドし S3 にデプロイ・配信する
gitbook試してみた - Qiita