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

Downloads:

17,285

Downloads of v 4.0.2:

501

Last Update:

21 May 2021

Package Maintainer(s):

Software Author(s):

  • Georg Brandl

Tags:

sphinx restructuredtext markdown documentation foss cross-platform cli

Sphinx

This is not the latest version of Sphinx available.

  • 1
  • 2
  • 3

4.0.2 | Updated: 21 May 2021

Downloads:

17,285

Downloads of v 4.0.2:

501

Maintainer(s):

Software Author(s):

  • Georg Brandl

Sphinx 4.0.2

This is not the latest version of Sphinx 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 Sphinx, run the following command from the command line or from PowerShell:

>

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

>

To uninstall Sphinx, 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 sphinx -y --source="'INTERNAL REPO URL'" --version="'4.0.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 sphinx -y --source="'INTERNAL REPO URL'" --version="'4.0.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 sphinx
  win_chocolatey:
    name: sphinx
    version: '4.0.2'
    source: INTERNAL REPO URL
    state: present

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


chocolatey_package 'sphinx' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '4.0.2'
end

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


cChocoPackageInstaller sphinx
{
    Name     = "sphinx"
    Version  = "4.0.2"
    Source   = "INTERNAL REPO URL"
}

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


package { 'sphinx':
  ensure   => '4.0.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 21 May 2021.

Description

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx!

Features

  • Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text.
  • Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information.
  • Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
  • Automatic indices: general index as well as a language-specific module indices.
  • Code handling: automatic highlighting using the Pygments highlighter.
  • Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more.
  • Contributed extensions: more than 50 extensions contributed by users in a second repository; most of them installable from PyPI

tools\chocolateyinstall.ps1
Update-SessionEnvironment

$version = '4.0.2'

$proxy = Get-EffectiveProxy
if ($proxy) {
  Write-Host "Setting CLI proxy: $proxy"
  $env:http_proxy = $env:https_proxy = $proxy
}

python -m ensurepip #check whether python has pip
python -m pip install Sphinx==$version
tools\chocolateyuninstall.ps1
python -m pip uninstall Sphinx -y

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
Sphinx 7.0.1 1664 Saturday, May 13, 2023 Approved
Sphinx 6.2.1 361 Tuesday, April 25, 2023 Approved
Sphinx 6.2.0 94 Monday, April 24, 2023 Approved
Sphinx 6.1.3 1388 Tuesday, January 10, 2023 Approved
Sphinx 6.1.2 111 Sunday, January 8, 2023 Approved
Sphinx 6.1.1 86 Friday, January 6, 2023 Approved
Sphinx 6.1.0 46 Thursday, January 5, 2023 Approved
Sphinx 6.0.0 175 Thursday, December 29, 2022 Approved
Sphinx 5.3.0 1124 Sunday, October 16, 2022 Approved
Sphinx 5.2.3 314 Friday, September 30, 2022 Approved
Sphinx 5.2.2 200 Tuesday, September 27, 2022 Approved
Sphinx 5.2.1 153 Monday, September 26, 2022 Approved
Sphinx 5.2.0 66 Sunday, September 25, 2022 Approved
Sphinx 5.1.1 828 Wednesday, July 27, 2022 Approved
Sphinx 5.1.0 90 Sunday, July 24, 2022 Approved
Sphinx 5.0.2 462 Friday, June 17, 2022 Approved
Sphinx 5.0.1 356 Friday, June 3, 2022 Approved
Sphinx 5.0.0 145 Monday, May 30, 2022 Approved
Sphinx 4.5.0 798 Sunday, March 27, 2022 Approved
Sphinx 4.4.0 1187 Sunday, January 16, 2022 Approved
Sphinx 4.3.2 293 Sunday, December 19, 2021 Approved
Sphinx 4.3.1 367 Saturday, November 27, 2021 Approved
Sphinx 4.3.0 410 Thursday, November 11, 2021 Approved
Sphinx 4.2.0 844 Sunday, September 12, 2021 Approved
Sphinx 4.1.2 577 Tuesday, July 27, 2021 Approved
Sphinx 4.1.1 170 Thursday, July 15, 2021 Approved
Sphinx 4.1.0 134 Monday, July 12, 2021 Approved
Sphinx 4.0.3 172 Monday, July 5, 2021 Approved
Sphinx 4.0.2 501 Friday, May 21, 2021 Approved
Sphinx 4.0.1 191 Tuesday, May 11, 2021 Approved
Sphinx 4.0.0 112 Sunday, May 9, 2021 Approved
Sphinx 3.5.4 337 Sunday, April 11, 2021 Approved
Sphinx 3.5.3 278 Saturday, March 20, 2021 Approved
Sphinx 3.5.2 245 Saturday, March 6, 2021 Approved
Sphinx 3.5.1 114 Tuesday, February 16, 2021 Approved
Sphinx 3.5.0 103 Sunday, February 14, 2021 Approved
Sphinx 3.4.3 162 Friday, January 8, 2021 Approved
Sphinx 3.4.2 100 Monday, January 4, 2021 Approved
Sphinx 3.4.1 97 Monday, December 28, 2020 Approved
Discussion for the Sphinx Package

Ground Rules:

  • This discussion is only about Sphinx and the Sphinx 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 Sphinx, 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