ドキュメントのフォルダ構成を整理

内部ドキュメント（DoxygenとHTAGS）は、doc_innerフォルダに作成
外部ドキュメント（マニュアル）は、docフォルダに作成
マニュアルHTMLファイルの名前をdoc/yacasl2.htmlからdoc/index.htmlに変更

diff --git a/.gitignore b/.gitignore
index cb89184..0780a99 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
 /casl2
 /comet2
 /dumpword
+/doc_inner
 *.o
 *~
 GPATH

diff --git a/Doxyfile b/Doxyfile
index f064982..7971b95 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NUMBER         =
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = doc/doxygen
+OUTPUT_DIRECTORY       = doc_inner/doxygen
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output

diff --git a/Makefile b/Makefile
index ccc16d7..77168cb 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,9 +1,10 @@
 .PHONY: build check doc doxygen clean gtags htags
 MKDIR = mkdir -p
+MV = mv
 DOXYGEN = doxygen
 GTAGS = gtags
 HTAGS = htags
-HTAGSFLAG = --map-file -anosx --tree-view
+HTAGSFLAG = -anosx
 
 build:
        $(MAKE) -C src
@@ -14,25 +15,39 @@ check:
 doc:
        @$(MAKE) -sC doc
 
-doxygen: htags
+doxygen: doc_inner
        @$(DOXYGEN)
 
 gtags:
        @$(GTAGS)
 
-htags: doc/doxygen/html gtags
+htags: doc_inner gtags
        @$(HTAGS) $(HTAGSFLAG) $</
 
-doc/doxygen/html:
+doc_inner:
        @$(MKDIR) $@
 
-clean:
+clean: clean_cmd clean_src clean_gtags clean_systemtest clean_unittest clean_doc_inner clean_doc
+
+clean_cmd:
+       @rm -f casl2 comet2 dumpword
+
+clean_gtags:
+       @rm -f GPATH GRTAGS GSYMS GTAGS
+
+clean_src:
        @$(MAKE) -sC src clean
+
+clean_systemtest:
        @$(MAKE) -sC test/system/casl2 clean
        @$(MAKE) -sC test/system/comet2 clean
        @$(MAKE) -sC test/system/dumpword clean
+
+clean_unittest:
        @$(MAKE) -sC test/unit clean
-       @rm -rf doc/doxygen/*
-       @rm -f casl2 comet2 dumpword
-       @rm -f GPATH GRTAGS GSYMS GTAGS
-       @rm -rf HTML
+
+clean_doc_inner:
+       @rm -rf doc_inner
+
+clean_doc:
+       @$(MAKE) -sC doc clean

diff --git a/README b/README
index de40d26..befaa42 100644 (file)
--- a/README
+++ b/README
@@ -9,8 +9,7 @@ CASL IIは、情報処理試験で用いられるアセンブラ言語で、次
       別紙 1 アセンブラ言語の仕様
 
 ■ドキュメント
-YACASL2のインストール方法、使い方などは次のドキュメントを参照してください。
-doc/yacasl2.html
+YACASL2のインストール方法、使い方などはファイルdoc/index.htmlを参照してください。
 
 ■Webサイト
 次のURLを参照してください。
@@ -20,4 +19,4 @@ http://www.j8takagi.net/yacasl2/
 Copyright 2010-2011, j8takagi.
 YACASL2 is licensed under the MIT license.
 
-詳細は、LICENSEを参照してください。
+ライセンスの詳細は、ファイルLICENSEを参照してください。

diff --git a/doc/Makefile b/doc/Makefile
index 2008539..7280fb0 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -6,6 +6,7 @@ PTEX = ptex
 TEXI2DVI = texi2dvi
 DVI2PDF = dvipdfmx
 MAKEINFO = makeinfo
+MV = mv
 
 .PHONY: all htmlnosplit pdf clean
 
@@ -14,6 +15,7 @@ MAKEINFO = makeinfo
 doc: info htmlnosplit html pdf
 
 htmlnosplit: $(DOCNAME).html
+       $(MV) $< index.html
 
 html: $(SRC) $(CSS)
        @if test ! -s $@; then mkdir $@; fi;

diff --git a/doc/yacasl2.html b/doc/index.html
similarity index 100%
rename from doc/yacasl2.html
rename to doc/index.html