Chocolatey Fest - Chocolatey's inaugural conference on Windows Automation (WinOps) is coming - Learn more!

DocFX

Package test results have failed.

There are versions of this package awaiting moderation . See the Version History section below.

This package was rejected on 12/28/2017. The reviewer chocolatey-ops has listed the following reason(s):

qinezh (maintainer) on 23 Nov 2017 02:54:23 +00:00:

User 'qinezh' (maintainer) submitted package.

chocolatey-ops (reviewer) on 23 Nov 2017 03:28:38 +00:00:

docfx has passed automated validation. It may have or may still fail other checks like testing (verification).
NOTE: No required changes that the validator checks have been flagged! It is appreciated if you fix other items, but only Requirements will hold up a package version from approval. A human review could still turn up issues a computer may not easily find.

Notes

Notes typically flag things for both you and the reviewer to go over. Sometimes this is the use of things that may or may not be necessary given the constraints of what you are trying to do and/or are harder for automation to flag for other reasons. Items found in Notes might be Requirements depending on the context. A package version can be approved without addressing Note comments.

  • The package maintainer field (owners) matches the software author field (authors) in the nuspec. The reviewer will ensure that the package maintainer is also the software author. More...

chocolatey-ops (reviewer) on 23 Nov 2017 03:32:26 +00:00:

docfx has failed automated testing.
This is not the only check that is performed so check the package page to ensure a 'Ready' status.
Please visit https://gist.github.com/c305a4607262dba2081cc30be662a526 for details.
The package status will be changed and will be waiting on your next actions.

  • NEW! We have a test environment for you to replicate the testing we do. This can be used at any time to test packages! See https://github.com/chocolatey/chocolatey-test-environment
  • Please log in and leave a review comment if you have questions and/or comments.
  • If you see the verifier needs to rerun testing against the package without resubmitting (a issue in the test results), you can do that on the package page in the review section.
  • If the verifier is incompatible with the package, please log in and leave a review comment if the package needs to bypass testing (e.g. package installs specific drivers).
  • Automated testing can also fail when a package is not completely silent or has pop ups (AutoHotKey can assist - a great example is the VeraCrypt package).
  • A package that cannot be made completely unattended should have the notSilent tag. Note that this must be approved by moderators.

chocolatey-ops (reviewer) on 13 Dec 2017 03:36:10 +00:00:

We've found docfx v2.27.1 in a submitted status and waiting for your next actions. It has had no updates for 20 or more days since a reviewer has asked for corrections. Please note that if there is no response or fix of the package within 15 days of this message, this package version will automatically be closed (rejected) due to being stale.

Take action:
* Log in to the site and respond to the review comments.
* Resubmit fixes for this version.
* If the package version is failing automated checks, you can self-reject the package.

If your package is failing automated testing, you can use the chocolatey test environment to manually run the verification and determine what may need to be fixed.

Note: We don't like to see packages automatically rejected. It doesn't mean that we don't value your contributions, just that we can not continue to hold packages versions in a waiting status that have possibly been abandoned. If you don't believe you will be able to fix up this version of the package within 15 days, we strongly urge you to log in to the site and respond to the review comments until you are able to.

chocolatey-ops (reviewer) on 28 Dec 2017 03:38:49 +00:00:

Unfortunately there has not been progress to move docfx v2.27.1 towards an approved status within 15 days after the last review message, so we need to close (reject) the package version at this time. If you want to pick this version up and move it towards approval in the future, use the contact site admins link on the package page and we can move it back into a submitted status so you can submit updates.

Status Change - Changed status of package from 'submitted' to 'rejected'.


DocFx is a documentation generation tool for API reference and Markdown files!

DocFX is an API documentation generator for .NET, and currently it supports C# and VB.
It generates API reference documentation from triple-slash comments in your source code.
It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation.
DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted on any web servers (for example, github.io).
Also, DocFX provides you the flexibility to customize the layout and style of your website through templates.
If you are interested in creating your own website with your own styles, you can follow how to create custom template to create custom templates.

Features

  • Website from Source Code and Markdown - DocFX generates Documentation directly from source code (.NET, RESTful API, JavaScript, Java, etc...) and Markdown files.
  • Run Everywhere - DocFX runs on Linux, macOS, and Windows. The generated website can be deployed to any web host with no additional configurations, e.g. Github Pages, Azure Websites...
  • Easy Customization - DocFX provides a flexible way to customize templates and themes easily.

Files

Hide
  • tools\chocolateyinstall.ps1 Show
    $ErrorActionPreference = 'Stop';
    
    $packageName= 'DocFX'
    $version    = 'v2.27.1'
    $toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
    $url        = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
    $sha1       = '38d878173eb8653d5287be69ce4e00eac0564789'
    
    $packageArgs = @{
      packageName   = $packageName
      unzipLocation = $toolsDir
      url           = $url
      checksum      = $sha1
      checksumType  = 'sha1'
    }
    
    Install-ChocolateyZipPackage @packageArgs
    

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

This package has no dependencies.

Package Maintainer(s)

Software Author(s)

  • Microsoft

Copyright

© 2015-2017 Microsoft

Tags

Release Notes

See https://github.com/dotnet/docfx/blob/master/RELEASENOTE.md

Version History

Version Downloads Last updated Status
DocFX 2.37.1 6 Friday, July 20, 2018 waiting for maintainer
DocFX 2.36.2 807 Wednesday, June 13, 2018 approved
DocFX 2.36.1 893 Thursday, May 24, 2018 approved
DocFX 2.36 372 Friday, May 18, 2018 approved
DocFX 2.35.4 798 Wednesday, May 2, 2018 approved
DocFX 2.35.2 358 Thursday, April 26, 2018 approved
DocFX 2.35.1 58 Thursday, April 26, 2018 approved
DocFX 2.35 110 Wednesday, April 25, 2018 approved
DocFX 2.34 733 Wednesday, April 4, 2018 approved
Show More

Discussion for the DocFX Package

Ground rules:

  • This discussion is only about DocFX and the DocFX package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or DocFX, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok