Downloads:

1,290

Downloads of v 4.0.2:

334

Last Update:

21 May 2021

Package Maintainer(s):

Software Author(s):

  • Georg Brandl

Tags:

sphinx reStructuredText markdown documentation foss cross-platform cli

Sphinx

  • 1
  • 2
  • 3

4.0.2 | Updated: 21 May 2021

Downloads:

1,290

Downloads of v 4.0.2:

334

Maintainer(s):

Software Author(s):

  • Georg Brandl

  • 1
  • 2
  • 3
Sphinx 4.0.2

  • 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

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:

>

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

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • 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. Enter your internal repository url

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

4. Choose your deployment method:


choco upgrade sphinx -y --source="'STEP 3 URL'" [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="'STEP 3 URL'"
$exitCode = $LASTEXITCODE

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

Exit $exitCode

- name: Ensure sphinx installed
  win_chocolatey:
    name: sphinx
    state: present
    version: 4.0.2
    source: STEP 3 URL

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


chocolatey_package 'sphinx' do
  action    :install
  version  '4.0.2'
  source   'STEP 3 URL'
end

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


Chocolatey::Ensure-Package
(
    Name: sphinx,
    Version: 4.0.2,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller sphinx
{
   Name     = 'sphinx'
   Ensure   = 'Present'
   Version  = '4.0.2'
   Source   = 'STEP 3 URL'
}

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


package { 'sphinx':
  provider => 'chocolatey',
  ensure   => '4.0.2',
  source   => 'STEP 3 URL',
}

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


salt '*' chocolatey.install sphinx version="4.0.2" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

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.

Version Downloads Last Updated Status
Sphinx 4.0.1 118 Tuesday, May 11, 2021 Approved
Sphinx 4.0.0 24 Sunday, May 9, 2021 Approved
Sphinx 3.5.4 269 Sunday, April 11, 2021 Approved
Sphinx 3.5.3 200 Saturday, March 20, 2021 Approved
Sphinx 3.5.2 164 Saturday, March 6, 2021 Approved
Sphinx 3.5.1 43 Tuesday, February 16, 2021 Approved
Sphinx 3.5.0 24 Sunday, February 14, 2021 Approved
Sphinx 3.4.3 76 Friday, January 8, 2021 Approved
Sphinx 3.4.2 19 Monday, January 4, 2021 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