docgen:合并/追加库

Question

如何使用多个库包创建docgen解决方案？类似于Dart，左侧垂直菜单包含指向每个库的链接。示例:我有带5个项目的省道编辑器工作区

mowbotnavrc_server (server)
mowbotnavrc_web (client)
mowbotnavrc (library)
mowbotnavrc_protocol (library)
osswebwidgets (library)

我想要上面列出的从index.html左边菜单上列出的3个库包。当我添加更多的库时，它们都会在左边的菜单中得到一个链接。目前，我只能单独生成每个库，没有问题。

cd %project-folder%
:: <<< Run pub get to get the dependencies >>>
cmd /c %dart-sdk-bin%\pub get
cmd /c docgen.bat --verbose %OPTIONS% --out %ENV-PROJECT-DOCS% --no-include-sdk --no-include-dependent-packages --package-root=%project-folder%\packages %project-folder%\lib

根据文档添加的选项听起来像是我所需要的，但我从来没有让它工作过。

--append
Use the same format used the last time the docs were generated, 
as stated in library_list.json. Add the newly generated documentation
to the docs directory, library_list.json, and index.txt.

我使用的是Dart 1.4.0-dev.2.2版本。我认为如有任何建议请见谅。

Answer 1

只需将要添加的每个库文件添加为命令行末尾的附加参数即可。

有关示例，请参见generate-documentation.sh (AngularDart)。

Answer 2

根据Günter的回答，我可以使用Windows命令版本。也许其他人也会觉得有用。

:: ===========================================================================
:: DOCGEN: MOWBOT Dart Project
:: ===========================================================================
mode con:cols=135 lines=50

:: --------------------------------------------
:: Initialize environment variables
:: --------------------------------------------
setlocal
set PATH-DARTSDKBIN=F:\Public\Downloads\Darteditor-windows-x64\dart\dart-sdk\bin
set PATH=%PATH%;%PATH-DARTSDKBIN%
set PATH-DARTPROJECTS=C:\Users\OSSDevYorgi\DartProjects
set PATH-DARTDOCS=C:\Users\OSSDevYorgi\DartDocs

set ERRORMSG=

:: --------------------------------------------
:: Initialize PATH-DARTDOCS & PATH-DARTDOCS-MOWBOT folders
:: --------------------------------------------
IF NOT EXIST %PATH-DARTDOCS% mkdir %PATH-DARTDOCS%
set PATH-DARTDOCS-MOWBOT=%PATH-DARTDOCS%\mowbot

IF NOT EXIST %PATH-DARTDOCS-MOWBOT% (
   mkdir %PATH-DARTDOCS-MOWBOT% 1> nul
) ELSE (
   del %PATH-DARTDOCS-MOWBOT% /s /q 1> nul
)

:: --------------------------------------------
:: MAIN DOC PROJECT:mowbotnavrc
:: -------------------------------------------- 
set PROJECT-NAME=mowbotnavrc
set PATH-PROJECT=%PATH-DARTPROJECTS%\libraries\%PROJECT-NAME%
set PROJECTLIBS=lib\mowbotnavrc.dart
set PROJECTLIBS=%PROJECTLIBS% %PATH-DARTPROJECTS%\libraries\mowbotnavrc_protocol\lib\protobufs\mowbot.pb.dart
set PROJECTLIBS=%PROJECTLIBS% %PATH-DARTPROJECTS%\webcomponents\osswebwidgets\lib\instruments.dart
::set PROJECTLIBS=%PROJECTLIBS% %PATH-DARTPROJECTS%\webcomponents\osswebwidgets\lib\guages.dart

::set STARTPAGE=%PROJECT-NAME%

:: --------------------------------------------
:: VERIFY FOLDERS EXIST
:: --------------------------------------------
@IF EXIST %PATH-PROJECT% goto :BUILDDOCS
@set ERRORMSG="PATH NOT FOUND "%PATH-PROJECT%
@goto :ERRORHANDLER

:: --------------------------------------------
:: SUBROUTINE:BUILDDOCS
:: --------------------------------------------
:BUILDDOCS

:: --------------------------------------------
:: Hack:Temporary workaround for pre-existing dartdoc-viewer causes "docgen --serve" to fail
:: --------------------------------------------
set ENV-PROJECT-DOCS=%PATH-PROJECT%\dartdoc-viewer
IF EXIST %ENV-PROJECT-DOCS% (
   rmdir %ENV-PROJECT-DOCS% /s /q 1> nul
)

set ENV-PROJECT-DOCS=%PATH-PROJECT%\nobackup\docs
IF NOT EXIST %ENV-PROJECT-DOCS% (
   mkdir %ENV-PROJECT-DOCS% 1> nul
) ELSE (
   del %ENV-PROJECT-DOCS% /s /q 1> nul
)

cd %PATH-PROJECT%
:: <<< Run pub get to get the dependencies >>>
::cmd /c %PATH-DARTSDKBIN%\pub get

cmd /c docgen.bat --serve --verbose --no-include-sdk ^
--include-dependent-packages ^
--out %ENV-PROJECT-DOCS% ^
--package-root=%PATH-PROJECT%\packages ^
--introduction=README.md ^
%PROJECTLIBS%

goto :exit

:: --------------------------------------------
:: SUBROUTINE:ERRORHANDLER
:: --------------------------------------------
:ERRORHANDLER
@echo.
@echo --------------------------------------------
@echo ERROR:%ERRORMSG%
@echo --------------------------------------------
@echo.

:: --------------------------------------------
:: END OF JOB
:: --------------------------------------------
:exit
pause