[
https://issues.apache.org/jira/browse/TINKERPOP-2018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16693733#comment-16693733
]
stephen mallette commented on TINKERPOP-2018:
---------------------------------------------
[~Florian Hockmann] i have docfx integrated with maven now and generating docs.
pretty neat. are you familiar with how to configure this thing to get better
output? A few things ugly right now:
1. I duplicated the
[index.md|https://github.com/apache/tinkerpop/commit/1b38ebd4f5b320a0dcecc6fa0b3047434e8cbc95#diff-5d1b9ad1ce95edb529c8244c23d3a526]
- it's a copy of {{README.md}}. I guess we should have on or the other and not
both or write a different set of content for the API docs. Personally, i
wouldn't mind if we got rid of a "landing" page all together and just had the
API docs front/center but I couldn't figure out how to make that work.
2. Not sure how to get our logo to replace that "D" logo
3. Not sure how best to kill the "D" .{{favicon}} - doesn't matter if we have
one or not, just would rather not have a "D"
4. Not sure if {{_site}} where the docs are generated should be in
{{/target/_site}}
5. There this "Improve this Doc" link on the "landing page" - not sure how to
kill that
6. Still not completely sure if this is building incrementally or not with
maven or if we need to be deleting some aspects of what is generated on the
"clean" maven phase.
Docs generate on "generate-resources" phase in maven so {{mvn clean install}}
over {{gremlin-dotnet-source}} should do everything (i.e. download docfx and
patch it then generate). You do need mono and nuget already in place for any of
this to work. They actually look pretty nice if we could just clean up those
issues i mentioned.
!junk.png!
> Generate API docs for Gremlin.Net
> ---------------------------------
>
> Key: TINKERPOP-2018
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2018
> Project: TinkerPop
> Issue Type: Improvement
> Components: build-release, documentation, dotnet
> Reporter: Florian Hockmann
> Assignee: stephen mallette
> Priority: Major
> Attachments: junk.png
>
>
> Similar to TINKERPOP-2010 which handles doc generation for
> gremlin-javascript, we should also generate and publish API docs for
> Gremlin.Net. We already have the necessary XML documentation comments in
> place for this.
> The docs could be generated with [DocFX|https://dotnet.github.io/docfx/]
> which I already used for [the API docs of the old pre-TinkerPop version of
> Gremlin.Net|https://florianhockmann.github.io/Gremlin.Net/api/Gremlin.Net.html].
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
