This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds API documentation to site. Adds verification in CI to ensure up …
…to date Signed-off-by: JoshVanL <vleeuwenjoshua@gmail.com>
- Loading branch information
Showing
791 changed files
with
121,750 additions
and
2,775 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| /_build/ | ||
| /.venv | ||
| /venv/ | ||
| /bin/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ================= | ||
| API documentation | ||
| ================= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| example_location: "examples" | ||
| api_groups: | ||
| - "Tarmak" | ||
| - "Wing" | ||
| - "Cluster" | ||
| resource_categories: | ||
| - name: "Tarmak" | ||
| include: "tarmak" | ||
| resources: | ||
| - name: "Config" | ||
| version: "v1alpha1" | ||
| group: "tarmak" | ||
| - name: "Cluster" | ||
| version: "v1alpha1" | ||
| group: "cluster" | ||
| - name: "Instance" | ||
| version: "v1alpha1" | ||
| group: "wing" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // https://jsfiddle.net/upqwhou2/ | ||
|
|
||
| $(document).ready(function() { | ||
| var navigationLinks = $('#sidebar-wrapper > ul li a'); | ||
| var navigationSections = $('#sidebar-wrapper > ul > ul'); | ||
| var sectionIdTonavigationLink = {}; | ||
| var sections = $('#page-content-wrapper').find('h1, h2').map(function(index, node) { | ||
| if (node.id) { | ||
| sectionIdTonavigationLink[node.id] = $('#sidebar-wrapper > ul li a[href="#' + node.id + '"]'); | ||
| return node; | ||
| } | ||
| }); | ||
| var sectionIdToNavContainerLink = {}; | ||
| var topLevelSections = $('#page-content-wrapper').find('h1').map(function(index, node) { | ||
| if (node.id) { | ||
| sectionIdToNavContainerLink[node.id] = $('#sidebar-wrapper > ul > ul[id="' + node.id + '-nav' +'"]'); | ||
| return node; | ||
| } | ||
| }); | ||
|
|
||
| var firstLevelNavs = $('#sidebar-wrapper > li'); | ||
| var secondLevelNavs = $('#sidebar-wrapper > ul > ul'); | ||
| var secondLevelNavContents = $('#sidebar-wrapper > ul > ul > li'); | ||
| var thirdLevelNavs = null; // TODO: When compile provides 3 level nav, implement | ||
|
|
||
| var sectionsReversed = $(sections.get().reverse()); | ||
|
|
||
| function checkScroll(event) { | ||
| var scrollPosition = $(window).scrollTop(); | ||
| var offset = 50; | ||
| scrollPosition += offset; | ||
| sections.each(function() { | ||
| var currentSection = $(this); | ||
| var sectionTop = $(this).offset().top; | ||
| var id = $(this).attr('id'); | ||
| if (scrollPosition >= sectionTop) { | ||
| navigationLinks.removeClass('selected'); | ||
| sectionIdTonavigationLink[id].addClass('selected'); | ||
| var sectionNavContainer = sectionIdToNavContainerLink[id]; | ||
| var sectionNavContainerDisplay; | ||
| if (sectionNavContainer) { | ||
| sectionNavContainerDisplay = sectionNavContainer.css('display'); | ||
| } | ||
| if (sectionNavContainer && sectionNavContainerDisplay === 'none') { | ||
| navigationSections.toggle(false); | ||
| sectionNavContainer.toggle(true); | ||
| } | ||
| } | ||
| if (($(this).offset().top < window.pageYOffset + 50) && $(this).offset().top + $(this).height() > window.pageYOffset) { | ||
| window.location.hash = id; | ||
| } | ||
| }); | ||
| } | ||
| checkScroll(); | ||
| $(window).on('scroll', function(event) { | ||
| checkScroll(event); | ||
| }); | ||
| }); |
Oops, something went wrong.