Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

DocFX 2.10.2

This is not the latest version of DocFX available.

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install DocFX, run the following command from the command line or from PowerShell:

>

To upgrade DocFX, run the following command from the command line or from PowerShell:

>

To uninstall DocFX, run the following command from the command line or from PowerShell:

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade docfx -y --source="'INTERNAL REPO URL'" --version="'2.10.2'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade docfx -y --source="'INTERNAL REPO URL'" --version="'2.10.2'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install docfx
  win_chocolatey:
    name: docfx
    version: '2.10.2'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'docfx' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2.10.2'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller docfx
{
    Name     = "docfx"
    Version  = "2.10.2"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'docfx':
  ensure   => '2.10.2',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved as a trusted package on 04 Jan 2017.

Description

DocFx is a documentation generation tool for api reference and markdown files!

DocFX is an API documentation generator for .NET, currently supporting C# and VB, as similar to JSDoc or Sphinx. It has the ability to extract triple slash comments out from your source code. What's more, it has syntax to link additional files to API to add additional remarks. docfx will scan your source code and your additional conceptual files and generate a complete HTML documentation website for you. docfx provides the flexibility for you to customize the website through templates. We currently have several embedded templates, including websites containing pure static html pages and also website managed by AngularJS. Of cause, 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 to create custom templates.

Features

  • Generate API Documentation - Able to generate API documentation from triple-slash-comments for .NET source code directly!
  • Generate Conceptual Documentation - Able to generate HTML from markdown files supporting DFM syntax.
  • Easy Customization - Able to customize templates and themes easily

tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop';

$packageName= 'DocFX'
$version    = 'v2.10.2'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url        = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
$sha1       = 'dbe5a57e553cc4fe18b6f6a941a1644ce2b2663d'

$packageArgs = @{
  packageName   = $packageName
  unzipLocation = $toolsDir
  url           = $url
  checksum      = $sha1
  checksumType  = 'sha1'
}

Install-ChocolateyZipPackage @packageArgs

Log in or click on link to see number of positives.

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.

Add to Builder Version Downloads Last Updated Status
DocFX 2.59.3 38570 Wednesday, July 6, 2022 Approved
DocFX 2.59.2 23771 Monday, April 11, 2022 Approved
DocFX 2.59.1 2467 Thursday, March 31, 2022 Approved
DocFX 2.59.0 20264 Wednesday, January 19, 2022 Approved
DocFX 2.58.9 16840 Thursday, November 4, 2021 Approved
DocFX 2.58.8 458 Wednesday, November 3, 2021 Approved
DocFX 2.58.5 48732 Tuesday, October 26, 2021 Approved
DocFX 2.58.4 13057 Tuesday, September 14, 2021 Approved
DocFX 2.58.2 5549 Tuesday, August 24, 2021 Approved
DocFX 2.58 25901 Wednesday, June 16, 2021 Approved
DocFX 2.57.2 20819 Tuesday, April 20, 2021 Approved
DocFX 2.57.1 2052 Tuesday, April 13, 2021 Approved
DocFX 2.57 832 Friday, April 9, 2021 Approved
DocFX 2.56.7 14938 Tuesday, March 2, 2021 Approved
DocFX 2.56.6 30997 Thursday, December 10, 2020 Approved
DocFX 2.56.5 7091 Tuesday, November 10, 2020 Approved
DocFX 2.56.4 8578 Tuesday, October 20, 2020 Approved
DocFX 2.56.2 20124 Monday, July 27, 2020 Approved
DocFX 2.56.1 4125 Monday, July 6, 2020 Approved
DocFX 2.56 1135 Monday, June 29, 2020 Approved
DocFX 2.55 4308 Friday, June 12, 2020 Approved
DocFX 2.54 3559 Monday, May 25, 2020 Approved
DocFX 2.53.1 2561 Monday, May 11, 2020 Approved
DocFX 2.53 323 Monday, May 11, 2020 Approved
DocFX 2.52 6521 Saturday, April 11, 2020 Approved
DocFX 2.51 13651 Friday, March 20, 2020 Approved
DocFX 2.50 3473 Monday, March 2, 2020 Approved
DocFX 2.49 45293 Monday, February 17, 2020 Approved
DocFX 2.48.1 10183 Monday, January 6, 2020 Approved
DocFX 2.48 7114 Monday, December 9, 2019 Approved
DocFX 2.47 6488 Tuesday, October 29, 2019 Approved
DocFX 2.46 2368 Saturday, October 12, 2019 Approved
DocFX 2.45.1 6621 Thursday, September 12, 2019 Approved
DocFX 2.45 2745 Friday, August 23, 2019 Approved
DocFX 2.44 2961 Friday, August 2, 2019 Approved
DocFX 2.43.4 184 Friday, August 2, 2019 Approved
DocFX 2.43.3 2727 Monday, July 15, 2019 Approved
DocFX 2.43.2 2326 Monday, June 24, 2019 Approved
DocFX 2.43.1 727 Wednesday, June 19, 2019 Approved
DocFX 2.43 1268 Thursday, June 13, 2019 Approved
DocFX 2.42.4 4051 Friday, May 24, 2019 Approved
DocFX 2.42.3 1560 Monday, May 13, 2019 Approved
DocFX 2.42.2 348 Friday, May 10, 2019 Approved
DocFX 2.42.1 2164 Tuesday, April 23, 2019 Approved
DocFX 2.42 796 Friday, April 19, 2019 Approved
DocFX 2.41 2914 Friday, March 29, 2019 Approved
DocFX 2.40.12 1724 Monday, March 11, 2019 Approved
DocFX 2.40.11 1886 Friday, February 15, 2019 Approved
DocFX 2.40.10 1137 Friday, February 1, 2019 Approved
DocFX 2.40.9 290 Thursday, January 31, 2019 Approved
DocFX 2.40.8 487 Friday, January 25, 2019 Approved
DocFX 2.40.7 1099 Friday, January 4, 2019 Approved
DocFX 2.40.6 793 Wednesday, December 19, 2018 Approved
DocFX 2.40.5 443 Monday, December 17, 2018 Approved
DocFX 2.40.4 1183 Monday, November 26, 2018 Approved
DocFX 2.40.3 382 Friday, November 23, 2018 Approved
DocFX 2.40.1 2013 Monday, October 29, 2018 Approved
DocFX 2.40 1061 Friday, October 12, 2018 Approved
DocFX 2.39.2 1528 Sunday, September 9, 2018 Approved
DocFX 2.39.1 556 Monday, September 3, 2018 Approved
DocFX 2.39 354 Saturday, September 1, 2018 Approved
DocFX 2.38.1 1129 Thursday, August 16, 2018 Approved
DocFX 2.38 423 Monday, August 13, 2018 Approved
DocFX 2.37.2 981 Tuesday, July 31, 2018 Approved
DocFX 2.37.1 660 Monday, July 23, 2018 Approved
DocFX 2.37 1418 Friday, June 29, 2018 Approved
DocFX 2.36.2 1070 Wednesday, June 13, 2018 Approved
DocFX 2.36.1 1605 Thursday, May 24, 2018 Approved
DocFX 2.36 619 Friday, May 18, 2018 Approved
DocFX 2.35.4 1069 Wednesday, May 2, 2018 Approved
DocFX 2.35.2 600 Thursday, April 26, 2018 Approved
DocFX 2.35.1 300 Thursday, April 26, 2018 Approved
DocFX 2.35 337 Wednesday, April 25, 2018 Approved
DocFX 2.34 998 Wednesday, April 4, 2018 Approved
DocFX 2.33.2 326 Monday, April 2, 2018 Approved
DocFX 2.33.1 805 Wednesday, March 21, 2018 Approved
DocFX 2.33 499 Monday, March 19, 2018 Approved
DocFX 2.32.2 790 Friday, March 9, 2018 Approved
DocFX 2.32.1 503 Tuesday, March 6, 2018 Approved
DocFX 2.32 563 Wednesday, February 28, 2018 Approved
DocFX 2.31 1254 Friday, February 2, 2018 Approved
DocFX 2.29.1 1655 Monday, December 25, 2017 Approved
DocFX 2.29 422 Friday, December 22, 2017 Approved
DocFX 2.28.3 583 Tuesday, December 12, 2017 Approved
DocFX 2.28.2 490 Thursday, December 7, 2017 Approved
DocFX 2.28.1 561 Friday, December 1, 2017 Approved
DocFX 2.28 383 Thursday, November 30, 2017 Approved
DocFX 2.27 1186 Thursday, November 9, 2017 Approved
DocFX 2.26.4 938 Monday, October 30, 2017 Approved
DocFX 2.26.3 528 Thursday, October 26, 2017 Approved
DocFX 2.26.1 454 Tuesday, October 24, 2017 Approved
DocFX 2.26 432 Monday, October 23, 2017 Approved
DocFX 2.25.2 698 Tuesday, October 10, 2017 Approved
DocFX 2.25.1 394 Monday, October 9, 2017 Approved
DocFX 2.25 342 Monday, October 9, 2017 Approved
DocFX 2.24 922 Monday, September 11, 2017 Approved
DocFX 2.23.1 840 Tuesday, August 22, 2017 Approved
DocFX 2.23 495 Monday, August 21, 2017 Approved
DocFX 2.22.3 460 Thursday, August 17, 2017 Approved
DocFX 2.22.2 699 Friday, August 4, 2017 Approved
DocFX 2.22 478 Monday, July 31, 2017 Approved
DocFX 2.21.2 560 Monday, July 24, 2017 Approved
DocFX 2.21.1 491 Monday, July 17, 2017 Approved
DocFX 2.21 370 Monday, July 17, 2017 Approved
DocFX 2.20 516 Monday, July 10, 2017 Approved
DocFX 2.19.2 528 Tuesday, June 27, 2017 Approved
DocFX 2.19.1 509 Wednesday, June 21, 2017 Approved
DocFX 2.19 439 Monday, June 19, 2017 Approved
DocFX 2.18.5 385 Thursday, June 15, 2017 Approved
DocFX 2.18.4 549 Friday, June 9, 2017 Approved
DocFX 2.18.3 424 Thursday, June 8, 2017 Approved
DocFX 2.18.2 500 Thursday, June 1, 2017 Approved
DocFX 2.18.1 415 Wednesday, May 31, 2017 Approved
DocFX 2.17.7 449 Wednesday, May 24, 2017 Approved
DocFX 2.17.6 376 Tuesday, May 23, 2017 Approved
DocFX 2.17.5 379 Tuesday, May 23, 2017 Approved
DocFX 2.17.4 485 Friday, May 12, 2017 Approved
DocFX 2.17.3 400 Thursday, May 11, 2017 Approved
DocFX 2.17.2 432 Tuesday, May 9, 2017 Approved
DocFX 2.17.1 369 Monday, May 8, 2017 Approved
DocFX 2.17 484 Thursday, May 4, 2017 Approved
DocFX 2.16.8 383 Wednesday, May 3, 2017 Approved
DocFX 2.16.7 606 Wednesday, April 26, 2017 Approved
DocFX 2.16.2 468 Wednesday, April 19, 2017 Approved
DocFX 2.16.1 373 Wednesday, April 19, 2017 Approved
DocFX 2.16 480 Monday, April 17, 2017 Approved
DocFX 2.15.5 561 Wednesday, April 5, 2017 Approved
DocFX 2.15.4 454 Saturday, April 1, 2017 Approved
DocFX 2.15.3 444 Wednesday, March 29, 2017 Approved
DocFX 2.15.2 364 Wednesday, March 29, 2017 Approved
DocFX 2.15.1 414 Tuesday, March 28, 2017 Approved
DocFX 2.14.1 543 Monday, March 20, 2017 Approved
DocFX 2.14 415 Monday, March 20, 2017 Approved
DocFX 2.13.2 1549 Thursday, March 16, 2017 Approved
DocFX 2.13.1 532 Tuesday, March 7, 2017 Approved
DocFX 2.13 381 Monday, March 6, 2017 Approved
DocFX 2.12.1 4115 Tuesday, February 14, 2017 Approved
DocFX 2.12 466 Monday, February 13, 2017 Approved
DocFX 2.11.3 486 Tuesday, February 7, 2017 Approved
DocFX 2.11.2 573 Wednesday, January 25, 2017 Approved
DocFX 2.11.1 383 Tuesday, January 24, 2017 Approved
DocFX 2.10.2 695 Wednesday, January 4, 2017 Approved
DocFX 2.10.1 389 Tuesday, January 3, 2017 Approved
DocFX 2.10 412 Tuesday, January 3, 2017 Approved
DocFX 2.9.3 655 Thursday, December 15, 2016 Approved
DocFX 2.9.2 438 Wednesday, December 14, 2016 Approved
DocFX 2.9.1 406 Tuesday, December 13, 2016 Approved
DocFX 2.9 464 Monday, December 12, 2016 Approved
DocFX 2.8.2 576 Friday, November 25, 2016 Approved
DocFX 2.8.1 417 Thursday, November 24, 2016 Approved
DocFX 2.8 421 Tuesday, November 22, 2016 Approved
DocFX 2.7.3 567 Monday, November 7, 2016 Approved
DocFX 2.7.2 511 Wednesday, November 2, 2016 Approved
DocFX 2.7.1 447 Tuesday, November 1, 2016 Approved
DocFX 2.7 445 Monday, October 31, 2016 Approved
DocFX 2.6.3 604 Monday, October 24, 2016 Approved
DocFX 2.6.2 434 Friday, October 21, 2016 Approved
DocFX 2.6.1 488 Tuesday, October 11, 2016 Approved
DocFX 2.6 448 Monday, October 10, 2016 Approved
DocFX 2.5.4 634 Thursday, September 22, 2016 Approved
DocFX 2.5.3 421 Tuesday, September 20, 2016 Approved
DocFX 2.5.2 418 Monday, September 19, 2016 Approved
DocFX 2.5.1 343 Monday, September 19, 2016 Approved
DocFX 2.5 503 Wednesday, September 14, 2016 Approved
DocFX 2.4 507 Monday, August 29, 2016 Approved
DocFX 2.3.1 442 Friday, August 19, 2016 Approved
DocFX 2.3 509 Monday, August 8, 2016 Approved
DocFX 2.2.2 467 Tuesday, July 26, 2016 Approved
DocFX 2.2.1 383 Wednesday, July 20, 2016 Approved
DocFX 2.2 395 Monday, July 18, 2016 Approved
DocFX 2.1 424 Tuesday, June 28, 2016 Approved
DocFX 1.4 496 Thursday, February 18, 2016 Approved

This package has no dependencies.

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