lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From NightOwl888 <...@git.apache.org>
Subject [GitHub] lucenenet issue #206: API Doc site generator using DocFx script
Date Fri, 30 Jun 2017 10:16:04 GMT
Github user NightOwl888 commented on the issue:

    https://github.com/apache/lucenenet/pull/206
  
    I have added some comments inline.
    
    I also [asked a question](https://stackoverflow.com/questions/44670354/how-do-you-create-code-references-with-custom-link-text-in-documentation-comment)
about creating code links in DocFx with custom link text that you might find the comments
helpful for.
    
    > As for changing how the namespaces are shown on the left hand side and ordering by
more important ones, this could be achieved by modifying the generated /api/toc.yml file after
it is built. This file is autogenerated by docfx when it's building the API docs. As far as
I can tell one way to do this would be with a custom Post Processor: https://dotnet.github.io/docfx/tutorial/howto_add_a_customized_post_processor.html
but OOTB I don't think this is possible with standard configuration.
    
    Normally when faced with post-build issues such as these I either overwrite the contents
of the file by [generating it in the Powershell script](https://github.com/apache/lucenenet/blob/master/build/build.ps1#L304-L351)
or use the Powershell script to update the contents of the file, depending on how much of
the file I need control over.
    
    But I wasn't referring to the order of them so much as the depth. For example, it would
be best if we had a link to `Lucene.Net.Analysis` in the TOC that when clicked expanded the
`Lucene.Net.Analysis.Ar`, `Lucene.Net.Analysis.Bg`, etc. instead of having all of the Analysis.Common
hierarchy in the initial view that loads.
    
    Anyway, I will wade through the rest of this and get back to you if I have any other questions/comments.


---
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