lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Shazwazza <...@git.apache.org>
Subject [GitHub] lucenenet issue #206: API Doc site generator using DocFx script
Date Fri, 07 Jul 2017 03:58:50 GMT
Github user Shazwazza commented on the issue:

    https://github.com/apache/lucenenet/pull/206
  
    Some updated info:
    
    * I've got the docfx build to work with the latest docfx version, the problem was this:
https://github.com/dotnet/docfx/issues/1817 which means I've had to exclude the SURROGATE
constants from the output docs (but i think that is probably fine), they're putting a requested
fix for this with the roslyn team
    * It would seem that it may be possible to get namespace documentation working. I've been
trying to research this using a docfx feature called 'overwrite' and there's mention that
it works so I've asked for feedback on the topic: https://github.com/dotnet/docfx/issues/229#issuecomment-313567058.
I've got overwrites to work at the class level which might be handy in the future but would
be great to see if it can work at the namespace level
    * I've added a WIKI section to show how that can be done, I've copied the HTML content
from the current wiki, I only did the home page, getting started and mail group pages as examples
and update the links between them. The html could/should be formatted to markdown (not sure
how the source of the current wiki is?) but that is optional but the links between pages should
be updated to markdowns since that's much easier to generate the links.
    
    There's still lots for me to look into based on the previous questions. I'll keep trying
out things as I find time.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message