Skip to content

Commit

Permalink
Update help generation to output to BuildOutput/Help to keep director…
Browse files Browse the repository at this point in the history
…ies consistent

Html help is now generated to html-shfb and html-mdoc directories
Include default namespace descriptions for mdoc xml
  • Loading branch information
cwensley committed Oct 15, 2012
1 parent 251e2b2 commit 1f788ff
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@
*.suo
bin/
obj/
/BuildOutput
/BuildOutput
*.shfbproj_*
2 changes: 1 addition & 1 deletion Help/Help.shfbproj
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
<OutputPath>..\BuildOutput\Docs\help\</OutputPath>
<OutputPath>..\BuildOutput\Help\html-shfb\</OutputPath>
<HtmlHelpName>EtoForms</HtmlHelpName>
<Language>en-US</Language>
<HelpFileFormat>Website</HelpFileFormat>
Expand Down
Binary file removed Help/Help.shfbproj_Administrator
Binary file not shown.
11 changes: 10 additions & 1 deletion Help/buildmdoc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
BUILD_OUTPUT_PATH=$DIR/../BuildOutput
INPUT_PATH=$BUILD_OUTPUT_PATH/Debug

OUTPUT_PATH=$BUILD_OUTPUT_PATH/Docs
OUTPUT_PATH=$BUILD_OUTPUT_PATH/Help
MDOC_OUTPUT_PATH=$OUTPUT_PATH/mdoc
MDOC_SOURCES_PATH=$MDOC_OUTPUT_PATH/sources
XML_OUTPUT_PATH=$OUTPUT_PATH/xml
HTML_OUTPUT_PATH=$OUTPUT_PATH/html-mdoc

rm -rf $MDOC_OUTPUT_PATH
rm -rf $XML_OUTPUT_PATH
mkdir -p $XML_OUTPUT_PATH
cp -r $DIR/xml/* $XML_OUTPUT_PATH
mdoc update -i "$INPUT_PATH/Eto.XML" -o "$XML_OUTPUT_PATH" "$INPUT_PATH/Eto.dll"
mkdir -p $MDOC_SOURCES_PATH
mdoc assemble -o "$MDOC_SOURCES_PATH/Eto" "$XML_OUTPUT_PATH"
Expand All @@ -32,3 +35,9 @@ MONODOC='<?xml version="1.0"?>\n
</node>'

echo -e $MONODOC > $MDOC_OUTPUT_PATH/monodoc.xml

if [ "$1" == "html" ]
then
rm -rf $HTML_OUTPUT_PATH
mdoc export-html -out "$HTML_OUTPUT_PATH" "$XML_OUTPUT_PATH"
fi
4 changes: 4 additions & 0 deletions Help/xml/index.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<Overview>
<Remarks>Eto Cross Platform Framework</Remarks>
<Copyright>(c) 2012 by Curtis Wensley</Copyright>
</Overview>
6 changes: 6 additions & 0 deletions Help/xml/ns-Eto.Drawing.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<Namespace Name="Eto.Drawing">
<Docs>
<summary>Graphics and Drawing</summary>
<remarks>Graphics and drawing routines</remarks>
</Docs>
</Namespace>
6 changes: 6 additions & 0 deletions Help/xml/ns-Eto.Forms.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<Namespace Name="Eto.Forms">
<Docs>
<summary>User Interface</summary>
<remarks>User interface forms and controls</remarks>
</Docs>
</Namespace>
6 changes: 6 additions & 0 deletions Help/xml/ns-Eto.IO.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<Namespace Name="Eto.IO">
<Docs>
<summary>Abstracted I/O</summary>
<remarks>Abstracted input/output interfaces</remarks>
</Docs>
</Namespace>
6 changes: 6 additions & 0 deletions Help/xml/ns-Eto.Misc.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<Namespace Name="Eto.Misc">
<Docs>
<summary>Obsolete namespace</summary>
<remarks>Obsolete namespace</remarks>
</Docs>
</Namespace>
6 changes: 6 additions & 0 deletions Help/xml/ns-Eto.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<Namespace Name="Eto">
<Docs>
<summary>Core functionality</summary>
<remarks>Core functionality of the Eto framework</remarks>
</Docs>
</Namespace>

0 comments on commit 1f788ff

Please sign in to comment.