You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by sh...@apache.org on 2020/07/01 00:03:37 UTC

[lucenenet] 01/01: Merge pull request #304 from apache/docs-poc

This is an automated email from the ASF dual-hosted git repository.

shazwazza pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git

commit 3d30140ddb95479f856cc705c8ce9436d996d23c
Merge: 3b92a59 07e1d13
Author: Shannon Deminick <sd...@gmail.com>
AuthorDate: Wed Jul 1 10:03:27 2020 +1000

    Merge pull request #304 from apache/docs-poc
    
    Docs overhaul and beta00009 docs release

 azure-pipelines.yml                                |   2 +-
 src/Lucene.Net/Codecs/package.md                   |  34 --
 .../Support/Codecs/DefaultCodecFactory.cs          |  99 ++++--
 .../Codecs/DefaultDocValuesFormatFactory.cs        |  98 ++++--
 .../Support/Codecs/DefaultPostingsFormatFactory.cs |  98 ++++--
 src/Lucene.Net/Support/Codecs/ICodecFactory.cs     |  10 +-
 .../Support/Codecs/IDocValuesFormatFactory.cs      |  10 +-
 .../Support/Codecs/IPostingsFormatFactory.cs       |  10 +-
 src/Lucene.Net/overview.md                         | 258 +++++++-------
 src/docs/.gitignore                                |   4 +
 src/docs/DocumentationTools.sln                    |   2 +-
 .../JavaDocToMarkdownConverter.csproj              |  70 +---
 .../JavaDocToMarkdownConverter/packages.config     |  71 ----
 .../EnvironmentVariableInlineRule.cs               |  56 +++
 .../EnvironmentVariableRendererPart.cs             |  43 +++
 .../LuceneDocsPlugins/LuceneDfmEngineCustomizer.cs |  11 +-
 .../LuceneDocsPlugins/LuceneDocsPlugins.csproj     |  63 +---
 src/docs/LuceneDocsPlugins/LuceneNoteBlockRule.cs  |   4 +-
 src/docs/LuceneDocsPlugins/LuceneNoteBlockToken.cs |   1 +
 ...dererPart.cs => LuceneNoteTokenRendererPart.cs} |   5 +-
 ...ererPartProvider.cs => RendererPartProvider.cs} |   6 +-
 src/docs/LuceneDocsPlugins/packages.config         |  40 ---
 src/docs/convert.ps1                               |  88 +++++
 src/docs/readme.md                                 |   2 +
 src/dotnet/tools/lucene-cli/docs/index.md          |   2 +-
 .../ManagedReference.common.js                     | 275 +++++++++++++++
 .../ManagedReference.extension.js                  |  33 +-
 .../ManagedReference.html.primary.js               |  59 ++++
 .../ManagedReference.html.primary.tmpl             |  13 +
 .../DefaultTemplateNoAssets/RestApi.common.js      | 309 ++++++++++++++++
 .../DefaultTemplateNoAssets/RestApi.extension.js   |  33 +-
 .../RestApi.html.primary.js                        |  41 ++-
 .../RestApi.html.primary.tmpl                      |   3 +
 .../UniversalReference.common.js                   | 308 ++++++++++++++++
 .../UniversalReference.extension.js                |  33 +-
 .../UniversalReference.html.primary.js             |  54 +--
 .../UniversalReference.html.primary.tmpl           |  12 +
 .../Templates/DefaultTemplateNoAssets/common.js    | 235 +++++++++++++
 .../conceptual.extension.js                        |  33 +-
 .../conceptual.html.primary.js                     |  35 +-
 .../conceptual.html.primary.tmpl                   |   4 +
 .../Templates/DefaultTemplateNoAssets/favicon.ico  | Bin 0 -> 99678 bytes
 .../DefaultTemplateNoAssets/layout/_master.tmpl    |  55 +++
 .../Templates/DefaultTemplateNoAssets/logo.svg     |  45 +++
 .../DefaultTemplateNoAssets/partials/_affix.liquid |  24 ++
 .../partials/_breadcrumb.liquid                    |   8 +
 .../partials/_footer.liquid                        |  16 +
 .../DefaultTemplateNoAssets/partials/_head.liquid  |  38 ++
 .../DefaultTemplateNoAssets/partials/_logo.liquid  |   8 +
 .../partials/_navbar.liquid                        |  21 ++
 .../partials/_scripts.liquid                       |   4 +
 .../DefaultTemplateNoAssets/partials/_toc.liquid   |   7 +
 .../partials/affix.tmpl.partial                    |  25 ++
 .../partials/breadcrumb.tmpl.partial               |   9 +
 .../partials/class.header.tmpl.partial             | 121 +++++++
 .../partials/class.tmpl.partial                    | 234 ++++++++++++
 .../partials/classSubtitle.tmpl.partial            |  28 ++
 .../partials/customMREFContent.tmpl.partial        |   2 +
 .../partials/dd-li.tmpl.partial                    |   3 +
 .../partials/enum.tmpl.partial                     |  50 +++
 .../partials/footer.tmpl.partial                   |  14 +
 .../partials/head.tmpl.partial                     |  20 ++
 .../partials/li.tmpl.partial                       |  30 ++
 .../partials/logo.tmpl.partial                     |   5 +
 .../partials/namespace.tmpl.partial                |  13 +
 .../partials/namespaceSubtitle.tmpl.partial        |  16 +
 .../partials/navbar.tmpl.partial                   |  22 ++
 .../partials/rest.child.tmpl.partial               |  87 +++++
 .../partials/rest.tmpl.partial                     |  37 ++
 .../partials/scripts.tmpl.partial                  |   5 +
 .../partials/searchResults.tmpl.partial            |   9 +
 .../partials/title.tmpl.partial                    |  43 +++
 .../partials/toc.tmpl.partial                      |   8 +
 .../partials/uref/class.header.tmpl.partial        |  43 +++
 .../partials/uref/class.tmpl.partial               | 235 +++++++++++++
 .../partials/uref/enum.tmpl.partial                |  35 ++
 .../partials/uref/parameters.tmpl.partial          |  28 ++
 .../DefaultTemplateNoAssets/search-stopwords.json  | 121 +++++++
 .../DefaultTemplateNoAssets/toc.extension.js       |  33 +-
 .../Templates/DefaultTemplateNoAssets/toc.html.js  |  57 +++
 .../DefaultTemplateNoAssets/toc.html.tmpl          |  21 ++
 .../Templates/DefaultTemplateNoAssets/token.json   |  46 +++
 .../LuceneApiDocs/partials/breadcrumb.tmpl.partial |  16 +
 .../LuceneTemplate/ManagedReference.extension.js   |  41 +++
 .../LuceneTemplate}/conceptual.html.primary.tmpl   |   0
 .../LuceneTemplate/partials/logo.tmpl.partial      |   5 +
 .../LuceneTemplate}/partials/navbar.tmpl.partial   |   0
 .../LuceneTemplateAssets}/styles/main.css          |  10 +
 .../LuceneTemplateAssets}/styles/main.js           |   0
 websites/apidocs/api/toc.yml                       |  81 -----
 websites/apidocs/apiSpec/core/Lucene_Net_Codecs.md | 391 +++++++++++++++++++++
 websites/apidocs/docfx.analysis-common.json        |  82 +++++
 websites/apidocs/docfx.analysis-kuromoji.json      |  76 ++++
 websites/apidocs/docfx.analysis-morfologik.json    |  76 ++++
 websites/apidocs/docfx.analysis-opennlp.json       |  76 ++++
 websites/apidocs/docfx.analysis-phonetic.json      |  76 ++++
 websites/apidocs/docfx.analysis-smartcn.json       |  76 ++++
 websites/apidocs/docfx.analysis-stempel.json       |  76 ++++
 websites/apidocs/docfx.benchmark.json              |  76 ++++
 websites/apidocs/docfx.classification.json         |  76 ++++
 websites/apidocs/docfx.codecs.json                 |  82 +++++
 websites/apidocs/docfx.core.json                   |  82 +++++
 websites/apidocs/docfx.demo.json                   |  76 ++++
 websites/apidocs/docfx.expressions.json            |  82 +++++
 websites/apidocs/docfx.facet.json                  |  82 +++++
 websites/apidocs/docfx.global.json                 |  14 +
 websites/apidocs/docfx.global.subsite.json         |   3 +
 websites/apidocs/docfx.grouping.json               |  82 +++++
 websites/apidocs/docfx.highlighter.json            |  82 +++++
 websites/apidocs/docfx.icu.json                    |  76 ++++
 websites/apidocs/docfx.join.json                   |  76 ++++
 websites/apidocs/docfx.json                        | 267 ++++++++++----
 websites/apidocs/docfx.memory.json                 |  76 ++++
 websites/apidocs/docfx.misc.json                   |  76 ++++
 websites/apidocs/docfx.queries.json                |  76 ++++
 websites/apidocs/docfx.queryparser.json            |  82 +++++
 websites/apidocs/docfx.replicator.json             |  76 ++++
 websites/apidocs/docfx.sandbox.json                |  82 +++++
 websites/apidocs/docfx.site.json                   |  73 ++++
 websites/apidocs/docfx.spatial.json                |  76 ++++
 websites/apidocs/docfx.suggest.json                |  82 +++++
 websites/apidocs/docfx.test-framework.json         |  69 ++++
 websites/apidocs/docs.ps1                          | 174 +++++++--
 websites/apidocs/filterConfig.yml                  |   5 +-
 websites/apidocs/index.md                          |  44 +--
 websites/apidocs/lucenetemplate/web.config         |  29 --
 websites/apidocs/toc.yml                           |   3 +-
 websites/apidocs/toc/analysis-common/toc.yml       |   3 +
 websites/apidocs/toc/analysis-kuromoji/toc.yml     |   3 +
 websites/apidocs/toc/analysis-morfologik/toc.yml   |   3 +
 websites/apidocs/toc/analysis-opennlp/toc.yml      |   3 +
 websites/apidocs/toc/analysis-phonetic/toc.yml     |   3 +
 websites/apidocs/toc/analysis-smartcn/toc.yml      |   3 +
 websites/apidocs/toc/analysis-stempel/toc.yml      |   3 +
 websites/apidocs/toc/benchmark/toc.yml             |   3 +
 websites/apidocs/toc/classification/toc.yml        |   3 +
 websites/apidocs/toc/codecs/toc.yml                |   3 +
 websites/apidocs/toc/core/toc.yml                  |   3 +
 websites/apidocs/toc/demo/toc.yml                  |   3 +
 websites/apidocs/toc/expressions/toc.yml           |   3 +
 websites/apidocs/toc/facet/toc.yml                 |   3 +
 websites/apidocs/toc/grouping/toc.yml              |   3 +
 websites/apidocs/toc/highlighter/toc.yml           |   3 +
 websites/apidocs/toc/icu/toc.yml                   |   3 +
 websites/apidocs/toc/join/toc.yml                  |   3 +
 websites/apidocs/toc/memory/toc.yml                |   3 +
 websites/apidocs/toc/misc/toc.yml                  |   3 +
 websites/apidocs/toc/queries/toc.yml               |   3 +
 websites/apidocs/toc/queryparser/toc.yml           |   3 +
 websites/apidocs/toc/replicator/toc.yml            |   3 +
 websites/apidocs/toc/sandbox/toc.yml               |   3 +
 websites/apidocs/toc/spatial/toc.yml               |   3 +
 websites/apidocs/toc/suggest/toc.yml               |   3 +
 websites/apidocs/toc/test-framework/toc.yml        |   3 +
 websites/apidocs/toc/toc.yml                       |   6 +
 websites/site/contributing/documentation.md        |  69 +++-
 websites/site/docs.md                              |   2 +
 websites/site/download/download.md                 |   6 +
 websites/site/download/toc.yml                     |   2 +
 websites/site/download/version-4.8.0-beta00007.md  |   3 +
 websites/site/download/version-4.8.0-beta00008.md  |   9 +-
 ...8.0-beta00008.md => version-4.8.0-beta00009.md} |  19 +-
 162 files changed, 6781 insertions(+), 870 deletions(-)