-
Notifications
You must be signed in to change notification settings - Fork 638
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Website & API Doc site generator using DocFx script (#206)
* Initial commit of powershell build to create an API doc site with docfx * Updates styles, etc... for the docs * updates build script to serve website * updates build to properly serve with an option to not clean cache files * adds index file for api docs * fixes a couple of crefs * creates custom docs files * updates script to ensure it only includes csproj's that are in the sln file * Adds wiki example docs, fixes up some toc, adds logging to build, fixes filter config, updates to latest docfx version, updates to correct LUCENENET TODO * Removes use of custom template files since we can just use the built in new metadata instead * Adds test files, fixing up some doc refs * Fixes namespace overwrite issue, adds solution for custom markdown plugin for parsing lucene tokens. * fixes exposed name of plugin * Moves source code for docs formatter to the 'src' folder * Updates build script to ensure the custom DocFx plugin is built for the custom tag parsing, adds readme, updates to latest docfx, includes more projects including the CLI project * Updates to latest docfx version * Splitting build into separate projects so we can browse APIs per project, fixes build issues with VS 2017 15.3, removes other test docs - will focus purely on the API docs part for now. * Gets projects all building separately, added a custom toc, and now we can browse by 'package' * updates build, ignore and toc * OK, gets projects -> namespace api docs working but the breadcrumb isn't working so need to figure that out * turns it into a 3 level toc for now which is better than before, awaiting feedback on gh * updates to latest docfx including the references in the docs plugin package * Gets CLI docs building and included as a header link and adds toc files for each folder * fixes some csproj refs * adds the Kuromoji package * Gets more building, includes the markdown docs for use as the namespace documentation * removes the replicator from the docs since that was erroring for some reason * Moves the docfx build yml files to a better temporary folder making it easier to cleanup, fixes the docfx build so that it properly builds - this was due to a change with the docfx version, puts the Replicator build back in * fixes the sln file since there was a duplicate project declared * fixes toc references * ensure the docfx log location is absolute * Adds demo, removes old unused doc example files, updates and includes a few more package.md files and updates the home page with correct linking * re-organizes the files that are included as files vs namespace overrides, updates docfx version and proj versions * Get the correct /api URI paths for the generated api docs * fix whitespace for the @lucene.experimental thing to work * Updates build to include TestFramework, updates index to match the java lucene docs with the propery xref's * Gets the index page back to normal with the deep links to API docs, fixes up a bunch of xref links * removes duplicate entry * removes the test framework docs from building because this causes collision issues with the same namespaces in the classes... the test framework classes would need a namespace change * Gets the website up and running with a nice template, updates styles across both websites * moves the quick start into a partial * Gets most info and links all ready for the website * Updates more docs for the website and fixes some invalid links * commits whitespace changes as a result of a slightly different doc converting logic * Revert "commits whitespace changes as a result of a slightly different doc converting logic" This reverts commit c7847af. * Updates docs based on the new output of the converter * Gets more docs converted properly with the converter * Updates the doc converter to append yaml headers correctly * Fixes most of the xref links * Fixes link parsing in the doc converter * removes breadcrumb from download doc, more xrefs fixed * Attempting to modify the markdig markdown engine to process special tags inside the triple-slash comments ... but can't get it to work so will revert back to dfm, just keeping this here for history * Revert "Attempting to modify the markdig markdown engine to process special tags inside the triple-slash comments ... but can't get it to work so will revert back to dfm, just keeping this here for history" This reverts commit efb0b00. * Gets the DFM markdown engine running again so the @lucene.experimental tags are replaced. * Updates some website info * Adds separate docs page to link to the various docs for different versions * fix typo * bumps the date, small change to the source code doc * Gets the download page all working for the different versions with checksums, etc... * Fixing links to the download-package
- Loading branch information
Showing
171 changed files
with
3,423 additions
and
793 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
Oops, something went wrong.