lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Shazwazza <...@git.apache.org>
Subject [GitHub] lucenenet pull request #206: API Doc site generator using DocFx script
Date Fri, 07 Jul 2017 00:37:38 GMT
Github user Shazwazza commented on a diff in the pull request:

    https://github.com/apache/lucenenet/pull/206#discussion_r126048419
  
    --- Diff: apidocs/docs.ps1 ---
    @@ -49,10 +49,17 @@ If ($FileExists -eq $False) {
     if ($Clean -eq 1) {
     	Remove-Item (Join-Path -Path $ApiDocsFolder "obj\*") -recurse -force -ErrorAction SilentlyContinue
     	Remove-Item (Join-Path -Path $ApiDocsFolder "obj") -force -ErrorAction SilentlyContinue
    -	Remove-Item (Join-Path -Path $ApiDocsFolder "api\*") -recurse -force -ErrorAction SilentlyContinue
    -	Remove-Item (Join-Path -Path $ApiDocsFolder "api") -force -ErrorAction SilentlyContinue
    +	Remove-Item (Join-Path -Path $ApiDocsFolder "api\*") -exclude "*.md" -recurse -force
-ErrorAction SilentlyContinue
    +	##Remove-Item (Join-Path -Path $ApiDocsFolder "api") -force -ErrorAction SilentlyContinue
     }
     
    +# NOTE: There's a ton of Lucene docs that we want to copy and re-format. I'm not sure
if we can really automate this 
    +# in a great way since the docs seem to be in many places, for example:
    +# Home page - 	https://github.com/apache/lucene-solr/blob/branch_4x/lucene/site/xsl/index.xsl
    +# Wiki docs - 	https://wiki.apache.org/lucene-java/FrontPage?action=show&redirect=FrontPageEN
- not sure where the source is for this
    +# Html pages - 	Example: https://github.com/apache/lucene-solr/blob/releases/lucene-solr/4.8.0/lucene/highlighter/src/java/org/apache/lucene/search/highlight/package.html
- these seem to be throughout the source
    +#				For these ones, could we go fetch them and download all *.html files from Git?
    +
    --- End diff --
    
    Yes good point about having the docs in their original place among the Lucene code as
it is in the java source. I'll see what can be done with regards to that.


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