文系プログラマによるTIPSブログスマートフォン用の表示で見る文系プログラマによるTIPSブログ文系プログラマ脳の私が開発現場で学んだ事やプログラミングのTIPSをまとめています。sphinxTwitterGooglePocketドキュメント生成ツールであるsphinxをmacのローカル環境にインストールし、動作するところまでまとめてみます。sphinxとはsphinx-users.jpsphinxはPython製ドキュメンテーションビルダーで、markdownのようなフォーマットに従ってテキストを書いてビルドすると、htmlやwordやpdfやtex等が生成できます。詳細はsphinxのサイトをご覧下さい。環境構築をしてみましょう。pyenvOSのバージョンによって初期インストールされているpythonのバージョンが異なったりするので、OSに依存せず初期インストールとは別に別途pythonをインストールするため、pyenvを導入します。macの場合はhomebrewでインストールすると楽です。homebrewならアインインストールも簡単です。以下でインストール可能なバージョンがずらっと一覧表示されるので、ここでは2.7系の最新版のバージョンを確認しましょう。2.4.5pyenvから任意のpythonバージョンをインストールするこの記事を書いた時点の2.7系の最新バージョンは「2.7.10」なので、2.7.10をインストールします。sphinxはv3系でも動作すると書かれていますが、windowsのチュートリアルの方には以下のように書かれているので、v2.7系の方が安全かと思われます。Pythonには2系と3系があります。Sphinx-1.2はPython-3.3でも動作します。一般的にはまだPython-2.7の系列が多く使われているので、何かあった場合のサポートをML等で受けやすいと思います。以降の説明ではPython-2.7を前提として進めます。パスを通す以下でグローバル設定されます。/Users/tree/.pyenv/version)v2.7.10がインストールされていますね。2.7.10これでmacに初期インストールされたpythonとは別に、pythonをどんどんインストール・アンインストールしていく事ができるようになりました。別途インストールされたpythonはホームディレクトリに「.pyenv」という隠しフォルダの中にインストールされます。versionspyenvによってここにpythonがインストールされ、OS標準のpythonのバイナリパスを上書く形でパスが通り、任意のpythonバージョンが使用できるようになります。pippipをインストールするsphinx、というかpythonのパッケージをインストールする場合はpipを使うと非常に管理が楽になります。/Users/tree/.pyenv/versions/2.7.10/lib/python2.7/site-packages」と書かれているので、OS標準のpythonの方ではなく、先ほどインストールしたpyenvの方にインストールされた事が解ります。今後pipでインストールしたパッケージは.pyenv配下にインストールされていきます。pipを最新版にアップデートする私がeasy_installでpipをインストールした時は何故か最新版がインストールされず、pipコマンド実行時に以下のinfoが表示されました。command.アップデートコマンドが書いてあるので、この通りに実行して最新版にしましょう。watchdog-0.8.3これでsphinxがインストールされました!!このままではsphinxにパスが通っていない(通っているが反映できていない)ので、以下でシェルを再起動します。-lこれでsphinxコマンドが実行可能になります。v1.3.1格好いいテーマをインストールするansible等で使用されている以下のテーマが格好いいです(個人的に)。インストール方法は↑に書いてあるので、そちらをご覧下さい。scaffold的なコマンドでひな形を生成する詳細はsphinxのチュートリアルを見て欲しいのですが、一応やってみます。linkcheck.生成ウィザード長っ!!最初は長くてちょっとビビリます。格好いいテーマを反映するテーマはインストールしただけでは適用されないため、config.pyに設定を反映する必要があります。config.pyは、build/conf.pyにあります。[sphinx_rtd_theme.get_html_theme_path()]https://github.com/snide/sphinx_rtd_themehtmlを出力する続いてhtmlをビルドします。実行前にcleanしておくと、前回生成したファイルを全削除してからビルドされます。build/html/index.htmlをブラウザ開いてみます。いい感じにできましたね。後はsphinxのサイトのリファレンスを見れば、大抵の事ができるようになるかと思います。雑感sphinxでドキュメントを生成すると、apacheのDocumentRootに配置すればwebで確認できるようになったり、バージョン管理で差分がはっきり解るようになります(excel等だとバイナリになって差分が解らない)。ついでにjsによる簡易検索機能も自動的に付くので、そろそろexcelのAPI仕様書を卒業して、本格的にsphinxに移行すべく勉強中なのです。週間)昔は業務系SIer、今はベンチャー企業でプログラムを書いています。INFILEを実行できるようにするmacのAutomatorでhomebrewのコマンドをFinderのサービスから実行できるようにするReactオススメ書籍React自体の基礎、AtomicDesignの適用、CSSの運用手法の歴史的な経緯とメリットデメリット、Reduxの基礎、redux-sagaによる非同期処理、サーバサイドレンダリング、テスト、lint、を学ぶ事ができます。単行本(ソフトカバー)この商品を含むブログを見るAngularオススメ書籍Angularを学ぶなら絶対以下がおすすめです!バインディング、ディレクティブ、パイプ、フォーム、コンポーネント、サービス、ルーティング、httpClientによる非同期httpリクエスト、テスト、angular-cli、を非常に丁寧な説明で網羅的に解説しています。大型本この商品を含むブログを見るSEOオススメ書籍SEOを学ぶなら絶対以下がおすすめです!クローラに対して何をどうすればサイトの巡回効率・速度を上げる事ができるのか、どういったマークアップをする事が標準仕様なのか。巷に溢れる業者による経験則に基づくオレオレSEO情報は一切無く、全てGoogle等のオフィシャルな情報に基づいて何をすべきか、どんな手段があるのかを解説されています。プログラマな私が業務で行った施策が多く書かれており、プログラマ寄りで高度な内容となっており、巷のビギナー向けの曖昧な情報集とは一線を画しています。Amazonアソシエイト・プログラムの参加者です。reserved.スターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。