2011-08-19 10 views
8

ソフトウェアプロジェクトに静的なHTMLドキュメントを提供したいときに、Sphinxに代わるものがあるのか​​どうか疑問に思っていました。スフィンクスは大丈夫だと思われますが、主にPythonの領域で使用されています。私は、潜在的にすべての種類のプロジェクトでPython関連だけでなく使用できるソリューションに興味があります。Sphinxがソフトウェアのマニュアルを提供するための良い選択肢はありますか?

私の目標は、そのようなマークダウンか何かで何かを文書化し、その後、私はまた、ゴラムを見ているユーザー(管理者)に配信される静的なHTMLサイト

を生成することであるが、これはGitHubのに結ばれる:(

答えて

5

SphinxはPython分野で主に使用されていることが大きな問題だと思いますか?SphinxはPythonで書かれていて、主にPythonのドキュメントに対応していることは事実ですが、IMHOは、

スフィンクスは、あなたが求めていることを正確に行うことができます: "documentマークダウンのようなものかそれに類するもので、その後は静的なHTMLサイトを生成する」スフィンクスはを使用しています。これは「そういうもの」のビットです。

少し違うことを試したい場合は、をお勧めします。

+1

スフィンクスには非常に多くのバグがあり、それを実行するような頭痛で、インポートエラーやシステムパスと3日間戦っている何か他のものをよく使うようにしています。 – minerals

3

Gollumをもう一度見てみるとよいでしょう。私のニーズはあなたの要求に似て聞こえるので、私はGollumについての私の考えを述べます。最近私はGollumをRailsプロジェクトのドキュメントとして使用し始めました。これまでの経験は非常に肯定的です。 Githubの人々によって開発されましたが、Githubのサービスに縛られておらず、Githubとは別に使用できます。

非常にアクティブなオープンソースプロジェクトで、多くのコミッターがいます。フレームワークはSinatraであり、あなたはあなたのパーソナルワークステーションで簡単に実行できます。開発マシンでGollumサーバーを稼動させたまま、Markdownファイルを直接編集して、ローカルのGollumサーバーで結果を表示します。これは、キーストロークでアップデートを自動的に追加するようにエディタを設定すると特に便利です。準備ができたら、thisプロジェクトを使用してGollum wikiから静的なhtmlサイトを生成することができます。

また、gitを使っているので、バージョン管理とgitのすべての機能が組み込まれています。

+2

あなたのメッセージのリンクは廃止されたリポジトリを参照しています。代わりにhttps://github.com/gollum/gollumを使用してください。 – ClementNerma

関連する問題