Skip to content

cfm-art/sphinx-docker-template

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

Sphinx Docker Compose Template

名前の通り、ドキュメント作成ツールの SphinxDocker Compose 用のテンプレートです。
たぶん動いています。

ライセンス

MIT

使い方

  1. Clone or Download からZIPをダウンロード
  2. ZIPを解凍
  3. (必要があれば) Dockerfile を変更
  4. (必要があれば) docker-compose.yml を変更
  5. (必要があれば) plantuml をインストール
  6. documents/source/conf.py を変更
  7. rstを記述する

Clone or Download からZIPをダウンロード

githubの Clone or Download ボタンを押し、 Download ZIP を押す。

ZIPを解凍

してください。

(必要があれば) Dockerfile を変更

必要があれば変更してくだいさい。

npmが手軽に欲しかったため、nodeイメージをベースにしています。
※ nodeイメージはdebianのようです。
python3-sphinx ではうまくビルドができなかったのでpip3のsphinxパッケージを使っています。

(必要があれば) docker-compose.yml を変更

必要があれば変更してくだいさい。

(必要があれば) plantuml をインストール

plantumlをドキュメント内で利用したい場合は公式から取得してください。
plantuml.jar の保存された場所は把握しておいてください。

documents/source/conf.py を変更

ドキュメントの設定を行う conf.py を編集します。
細かい設定は Sphinx公式を参照してください。

  • project = 'Sphinx-docker-template'
    • ドキュメントのタイトルへ変更します。
  • copyright = 'art'
    • コピーライトへ変更します。
  • author = 'art'
    • 記述者へ変更します。
  • version = '0.0.0'
    • ドキュメントバージョンへ随時変更します。
  • release = '0.0.0'
    • ドキュメントバージョンへ随時変更します。
  • # 'sphinxcontrib.plantuml',
    • plantumlを利用する場合は、先頭の # を取り除きます。
  • plantuml_path = os.path.abspath('../extensions/plantuml.jar')
    • plantumlを利用する場合は、 plantuml.jar のパスへ変更します。
      documents/extensionsフォルダへ配置した場合は変更は不要です。

rstを記述する

好きなようにrstを記述してください。

番外: uiflowについて

uiflow用の拡張を適当に作って含めています。

.. uiflow:: ファイル名

と記述することで使えます。

ファイルを用意しない以下のような形には対応させていません。

.. uiflow::

    これはうごきません。

English

Machine translation. Is this English correct?

Usage

  1. Download ZIP from Clone or Download
  2. Uncompress the ZIP
  3. (if necessary) Change Dockerfile
  4. (if necessary) Change docker-compose.yml
  5. (if necessary) Install plantuml
  6. Change documents/source/conf.py
  7. Just as you like write rst

Download ZIP from Clone or Download

Press Clone or Download in this github page and Press Download ZIP.

Uncompress the ZIP

Do it.

(if necessary) Change Dockerfile

If necessary, you change it.

This Image is from the node image. Cuz I need npm easily.

(if necessary) Change docker-compose.yml

If necessary, you change it.

(if necessary) Install plantuml

If you will use plantuml in sphinx, you get plantuml from offical site. ※ Do not forget installed-path.

Change documents/source/conf.py

Change conf.py. If you want to know details of setting, you look sphinx offical site.

  • project = 'Sphinx-docker-template'
    • Modify document title
  • copyright = 'art'
  • author = 'art'
  • version = '0.0.0'
    • Keep document version it updated.
  • release = '0.0.0'
    • Keep document version it updated.
  • # 'sphinxcontrib.plantuml',
    • if use plantuml, remove #.
  • plantuml_path = os.path.abspath('../extensions/plantuml.jar')
    • if use plantuml, change to installed-path of plantuml.jar
      if installed to documents/extensions, you do not it.

Just as you like write rst

Just as you like.

About

for Docker Compose.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published