GitHub user Shazwazza opened a pull request:
https://github.com/apache/lucenenet/pull/206
API Doc site generator using DocFx script
I remember seeing on the mail list that getting API docs generated was
still on the TODO list so here it is. This is a PR to build API documentation
using DocFx. I've committed the least amount of files possible, the script will
go retrieve the docfx.exe from the web so it's not part of the repository.
The files contained here are the build script, a few docfx yaml files and
some template files for styling.
To get the site built you can run: `/apidocs/docs.ps1` This will build the
metadata and output a host-able site at `/apidocs/_site`
If you want to test you can run: `/apidocs/docs.ps1 -ServeDocs 1` which
will build the metadata and start a webserver to test at http://localhost:8080
_(In both cases, the build operation takes a few minutes!)_
There's a home page that simply contains links to various Lucene docs but
this can be easily modified (it's markdown), it's also possible to add markdown
articles using docfx but I've removed these for now until we might want them.
The styling is simple but uses the Lucene logo, favicon and blue colors:
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/Shazwazza/lucenenet docfx-apidocs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/lucenenet/pull/206.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #206
----
commit 0e78fa3cdb0be9544dd1bca989cc7a1c69407c95
Author: Shannon <[email protected]>
Date: 2017-05-16T06:15:46Z
Initial commit of powershell build to create an API doc site with docfx
commit 98daf257235d06c3184147efd1bc789b645d557b
Author: Shannon <[email protected]>
Date: 2017-05-16T08:19:10Z
Updates styles, etc... for the docs
commit beec80a8e82546d4a609258664c686e12afb776b
Author: Shannon <[email protected]>
Date: 2017-05-16T08:32:53Z
updates build script to serve website
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
