【初めに】
今回が初投稿となります。
後で自分の成果を見てにやついたり、備忘録のために記事を作成していく予定です。たまに困っているひとの役に立てばいいかなというユルさで、今後よろしくお願いします。
専門用語はあまり使わない方向でいきます。
ご指摘等は大いにwelcomeです。
【記事の概要】
pydocをhtmlファイル形式で出力するとき各pythonファイル同士のリンクがうまくつながらなかったときにやったことの備忘録です。
batファイルの作成、コマンドプロンプトからpydocを作成する手法などは他の方が記事を上げているため割愛します。
👅自分はこちらの方の記事を参考にさせて頂きました。
https://sinsoku.hatenadiary.org/entry/20091030/1256902342
【環境】
Windows10
python3.6.4
【結論】
自分がやった手法は「出力したhtmlファイルを開いてコードを書き換えてリンクを付け直した」です。
パッケージすべてのpythonファイルをhtml出力して、
「init.py」のhtmlファイルにスクリプトをリンク付けするという内容です。
【やったことアレコレ】
１：pydoc.batの作成 → python.exeと同じフォルダへ移動させる。
２：コマンドプロンプトのcdコマンドで、pydocを書き出したいスクリプトのあるディレクトリへ移動する。
(カレントディレクトリを移動する)。
３：pydoc -w XXX.py
と打ち込みEnter。(XXXはスクリプトの名前を入力すべし。)
これでXXX.pyのフォルダ内にXXX.htmlが生成できているかもしれません。XXX.htmlを開くとブラウザが開き、コードの構成を表示します。
それをテキストエディタ等で開くとhtmlファイルを直接いじることができるため、リンクがつながっていない箇所のリンク付けを行って差し上げます。
この辺はhtmlでwebページを試しに作ったことがある人はピンとくると思います。
最後に
今回はあまり深く掘るつもりはないため、この辺で終えたいと思います。
まだマークダウンの書き方がよく分かったないため、暇なときにきれいに見える書き方でも模索してみます。
今回のドキュメントの生成手法は手間のかかるやり方でした。他のうまいやり方が絶対あったと思います。
まぁ同じ問題で悩んでいる方がいましたらこんなやり方でもリンク繋げますという一つの回答としてとらえて頂けましたら幸いです。
今度はsphinx使ってみようかな、機会があれば。