Sphinxでドキュメント作成するエディタ環境を整える(Mac向け)
こんにちは。阿形です。最近Sphinxでドキュメントを作成するようになっていますが、Sphinx自体の環境以外にも、いくつかやっておきたいことがあったので、メモ代わりにまとめておきます。なお、以下の説明はすべてmacOS High Sierraを使用する前提です。 フォントの追加 プログラミングやSphinxでドキュメント作成するとなるとどうしても全角文字と半角文字の混在が気になってきます。等幅フ […]
【Sphinx】blockdiag拡張を使用して図を挿入する
インターステラの阿形です。 最近仕様書を書くのにもSphinxを使っています。 reStructuredTextで文章を書くのはなかなかサクサク書けていいんですが、図は悩みどころ。 そこで簡単な図を挿入したいときに便利なblockdiag拡張を使ってみたので、その設定方法を書いていこうと思います。 blockdiagとは blockdiagとは、テキストからブロック図などの画像を生成するツール群で […]
【インターンステラ】GitLab＋Sphinx＋Google Cloud Storageで自動ビルド&デプロイするには
こんにちは、國分です。 今回は前回のAppEngineに代わり、CloudStorageにデプロイする方法を説明します。 前回とGitLab Runnerの構築までは同じなので省略します。 .gitlab-ci.ymlの作成 .gitlab-ci.yml image: python:2.7 stages: - pages - deploy pages: stage: pages script: - […]
【インターンステラ】GitLab＋Sphinx＋Google App Engineで自動ビルド&デプロイするには
こんにちは、國分です。 今回は、前々回行ったReSTのHTML化と、Pagesの代わりにGoogle App EngineへのデプロイをGitLabにPushした時、自動で行われるようにする方法を説明します。 前提 ・App Engineプロジェクトがあること ・$ gcloud app deploy コマンドでデプロイできる状況である (「サービスアカウント」と「プロジェクトID」を持っている […]
【インターンステラ】GitLab Runnerの構築
こんにちは、國分です。 今回はGitLab環境のCI/CDに必要なGitLab Runnerの構築方法を説明します。 公式ドキュメントはこちら バイナリのダウンロード $ sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/g […]
【インターンステラ】GitLab＋SphinxでHTMLを閲覧する方法
前回のsphinxで作成したHTMLをGitLab上で閲覧できるようにするまでの過程 GitLabにプロジェクトを作る。 https://gitlab.com/dashboard/projectsのNew projectからProject nameを決め、Create projectする。 Pushするには $ git config --global user.name "ユーザー名" $ git […]
【インターンステラ】Sphinxを試用してみる
こんにちは、國分です。 本日はドキュメント生成ツール「Sphinx」の試用について報告していきたいと思います。 チュートリアル通りにインストールから $ sudo pip install sphinx Cannot uninstall 'pyparsing'. It is a distutils installed project and thus we cannot accurately det […]
【インターンステラ】MacでPython3プログラミングを始める
岩佐です. MacでPython3のプログラミングを始められるようにしましょう. 初心者向けです. 作業はターミナルで行います. ターミナルを開く [Finder]→[アプリケーション]→[ユーティリティ]と移動すると, ターミナルがあると思います. 開きます. すると, なにやら出てきましたよね. これがターミナルです. これをDock(画面下のアプリケーション一覧)に追加しておきましょう. タ […]
【インターンステラ】MacにDockerを入れる~簡単なコマンドの説明まで~
岩佐です. Gitlab CEをMacで利用したいので, DockerをMacに入れたいと思います. Dockerのインストール docker公式サイトのDocker Community Edition for Macのページよりインストーラーをダウンロードします. （ダウンロードにはdocker storeへのログインが必要です.） ダウンロードしたDocker.dmgを起動しDRUG & […]
【インターンステラ】reStructuredTextの書き方
岩佐です. Sphinxでドキュメントを作成する際, reStructuredTextという簡易マークアップ言語を使って記述します. そこで, よく使いそうな簡単な構文を書いておきます. 以前Sphinxの始め方で作ったsample projectを使います. が, 新しく始めてもいいでしょう. その場合は, $ sphinx-quickstart Project nameとAuthor name […]