Skip to content

Commit

Permalink
docs: new build
Browse files Browse the repository at this point in the history
  • Loading branch information
@jordanrobot
jordanrobot committed Jan 17, 2021
1 parent 4c4f71a commit 71f4f51
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 119 deletions.
59 changes: 13 additions & 46 deletions docs/api/InventorShims.DocumentShim.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h3 id="methods">Methods
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_GetDocumentFromObject_System_Object_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.GetDocumentFromObject(System.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L249">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L252">View Source</a>
</span>
<a id="InventorShims_DocumentShim_GetDocumentFromObject_" data-uid="InventorShims.DocumentShim.GetDocumentFromObject*"></a>
<h4 id="InventorShims_DocumentShim_GetDocumentFromObject_System_Object_" data-uid="InventorShims.DocumentShim.GetDocumentFromObject(System.Object)">GetDocumentFromObject(Object)</h4>
Expand Down Expand Up @@ -168,7 +168,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_GetDocumentsFromSelectSet_SelectSet_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.GetDocumentsFromSelectSet(SelectSet)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L206">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L209">View Source</a>
</span>
<a id="InventorShims_DocumentShim_GetDocumentsFromSelectSet_" data-uid="InventorShims.DocumentShim.GetDocumentsFromSelectSet*"></a>
<h4 id="InventorShims_DocumentShim_GetDocumentsFromSelectSet_SelectSet_" data-uid="InventorShims.DocumentShim.GetDocumentsFromSelectSet(SelectSet)">GetDocumentsFromSelectSet(SelectSet)</h4>
Expand Down Expand Up @@ -219,7 +219,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsAssembly_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsAssembly(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L118">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L121">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsAssembly_" data-uid="InventorShims.DocumentShim.IsAssembly*"></a>
<h4 id="InventorShims_DocumentShim_IsAssembly_Document_" data-uid="InventorShims.DocumentShim.IsAssembly(Document)">IsAssembly(Document)</h4>
Expand Down Expand Up @@ -267,7 +267,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsDrawing_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsDrawing(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L128">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L131">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsDrawing_" data-uid="InventorShims.DocumentShim.IsDrawing*"></a>
<h4 id="InventorShims_DocumentShim_IsDrawing_Document_" data-uid="InventorShims.DocumentShim.IsDrawing(Document)">IsDrawing(Document)</h4>
Expand Down Expand Up @@ -315,7 +315,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsForeignModel_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsForeignModel(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L148">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L151">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsForeignModel_" data-uid="InventorShims.DocumentShim.IsForeignModel*"></a>
<h4 id="InventorShims_DocumentShim_IsForeignModel_Document_" data-uid="InventorShims.DocumentShim.IsForeignModel(Document)">IsForeignModel(Document)</h4>
Expand Down Expand Up @@ -363,7 +363,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsPart_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsPart(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L108">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L111">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsPart_" data-uid="InventorShims.DocumentShim.IsPart*"></a>
<h4 id="InventorShims_DocumentShim_IsPart_Document_" data-uid="InventorShims.DocumentShim.IsPart(Document)">IsPart(Document)</h4>
Expand Down Expand Up @@ -411,7 +411,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsPresentation_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsPresentation(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L138">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L141">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsPresentation_" data-uid="InventorShims.DocumentShim.IsPresentation*"></a>
<h4 id="InventorShims_DocumentShim_IsPresentation_Document_" data-uid="InventorShims.DocumentShim.IsPresentation(Document)">IsPresentation(Document)</h4>
Expand Down Expand Up @@ -459,7 +459,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsSat_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsSat(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L158">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L161">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsSat_" data-uid="InventorShims.DocumentShim.IsSat*"></a>
<h4 id="InventorShims_DocumentShim_IsSat_Document_" data-uid="InventorShims.DocumentShim.IsSat(Document)">IsSat(Document)</h4>
Expand Down Expand Up @@ -507,7 +507,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_IsUnknown_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.IsUnknown(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L168">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L171">View Source</a>
</span>
<a id="InventorShims_DocumentShim_IsUnknown_" data-uid="InventorShims.DocumentShim.IsUnknown*"></a>
<h4 id="InventorShims_DocumentShim_IsUnknown_Document_" data-uid="InventorShims.DocumentShim.IsUnknown(Document)">IsUnknown(Document)</h4>
Expand Down Expand Up @@ -555,7 +555,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_ObjectIsDocument_System_Object_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.ObjectIsDocument(System.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L398">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L401">View Source</a>
</span>
<a id="InventorShims_DocumentShim_ObjectIsDocument_" data-uid="InventorShims.DocumentShim.ObjectIsDocument*"></a>
<h4 id="InventorShims_DocumentShim_ObjectIsDocument_System_Object_" data-uid="InventorShims.DocumentShim.ObjectIsDocument(System.Object)">ObjectIsDocument(Object)</h4>
Expand Down Expand Up @@ -639,7 +639,7 @@ <h5 class="parameters">Parameters</h5>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_ReturnSpecificDocumentObject_Inventor_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.ReturnSpecificDocumentObject(Inventor.Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L179">View Source</a>
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L182">View Source</a>
</span>
<a id="InventorShims_DocumentShim_ReturnSpecificDocumentObject_" data-uid="InventorShims.DocumentShim.ReturnSpecificDocumentObject*"></a>
<h4 id="InventorShims_DocumentShim_ReturnSpecificDocumentObject_Inventor_Document_" data-uid="InventorShims.DocumentShim.ReturnSpecificDocumentObject(Inventor.Document)">ReturnSpecificDocumentObject(Inventor.Document)</h4>
Expand Down Expand Up @@ -698,7 +698,7 @@ <h4 id="InventorShims_DocumentShim_SaveSilently_Document_" data-uid="InventorShi
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SaveSilently(this Document documentToWork)</code></pre>
<pre><code class="lang-csharp hljs">public static void SaveSilently(this Document document)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
Expand All @@ -712,45 +712,12 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><span class="xref">Document</span></td>
<td><span class="parametername">documentToWork</span></td>
<td><span class="parametername">document</span></td>
<td><p>Document object</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_SaveWithFileDialog_Document_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.SaveWithFileDialog(Document)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/InventorCode/InventorShims/blob/master/src/InventorShims-cs/DocumentShim.cs/#L95">View Source</a>
</span>
<a id="InventorShims_DocumentShim_SaveWithFileDialog_" data-uid="InventorShims.DocumentShim.SaveWithFileDialog*"></a>
<h4 id="InventorShims_DocumentShim_SaveWithFileDialog_Document_" data-uid="InventorShims.DocumentShim.SaveWithFileDialog(Document)">SaveWithFileDialog(Document)</h4>
<div class="markdown level1 summary"><p>Saves, but shows the user a file dialog so they can pick where to save the document</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SaveWithFileDialog(this Document documentToWork)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Document</span></td>
<td><span class="parametername">documentToWork</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_DocumentShim_ScreenShot_Document_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20InventorShims.DocumentShim.ScreenShot(Document%2CSystem.String%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
Expand Down
3 changes: 0 additions & 3 deletions docs/api/InventorShims.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,6 @@ <h4><a class="xref" href="InventorShims.Conversions.html">Conversions</a></h4>
</section>
<h4><a class="xref" href="InventorShims.DocumentShim.html">DocumentShim</a></h4>
<section><p>Methods that extended the Inventor.Document object with additional functionality.</p>
</section>
<h4><a class="xref" href="InventorShims.DrawingDocumentShim.html">DrawingDocumentShim</a></h4>
<section><p>Methods that extend Inventor.DrawingDocument</p>
</section>
<h4><a class="xref" href="InventorShims.ParameterShim.html">ParameterShim</a></h4>
<section><p>A set of extension methods for the Document Parameters.</p>
Expand Down
3 changes: 0 additions & 3 deletions docs/api/toc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@
<li>
<a href="InventorShims.DocumentShim.html" name="" title="DocumentShim">DocumentShim</a>
</li>
<li>
<a href="InventorShims.DrawingDocumentShim.html" name="" title="DrawingDocumentShim">DrawingDocumentShim</a>
</li>
<li>
<a href="InventorShims.ParameterShim.html" name="" title="ParameterShim">ParameterShim</a>
</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/articles/contribution-guidelines.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,28 @@ <h3 id="version-numbers">Version Numbers</h3>
<li>MINOR - added functionality in a backwards compatible manner</li>
<li>PATCH - backwards compatible bug fixes</li>
</ul>
<h3 id="commit-guidelines">Commit Guidelines</h3>
<p><a href="https://www.conventionalcommits.org/en">Conventional Commits</a> will be used as the commit message guidelines. Following these simple guidelines will ensure commit message consistency that simplifies changelog generation and version number management. Contributors are encouraged to visit the page and read the tutorial and spec. Pull requests are expected to follow this convention.</p>
<p>A simple, breezy tutorial follows... commit messages should be in the form &quot;KEYWORD: message&quot;. Commit may have multiple lines. Try to keep each commit to a single keyword. This keyword is one of the following:</p>
<ul>
<li>build</li>
<li>chore</li>
<li>ci</li>
<li>docs</li>
<li>feat</li>
<li>fix</li>
<li>refactor</li>
<li>revert</li>
<li>style</li>
<li>test</li>
</ul>
<p>Breaking changes in the codebase are denoted by an exclamation mark after a keyword, such as:</p>
<ul>
<li>feat!</li>
<li>fix!</li>
<li>etc...</li>
</ul>
<p>A footer <code>BREAKING CHANGE:</code> should also be included in the commit message for human readability, but is not strictly required.</p>
<h3 id="license">License</h3>
<p>This code is under an MIT license.</p>
</article>
Expand Down
Loading

0 comments on commit 71f4f51

Please sign in to comment.