A conda-smithy repository for sphinx-argparse.
Shell
Latest commit 57614e8 Feb 26, 2017 @croth1 croth1 committed on GitHub Merge pull request #3 from croth1/bump-0.1.17
bumped to version 0.1.17

README.md

About sphinx-argparse

Home: https://github.com/ribozz/sphinx-argparse

Package license: MIT

Feedstock license: BSD 3-Clause

Summary: Sphinx extension that automatically document argparse commands and options

Current build status

Linux: Circle CI OSX: TravisCI Windows: AppVeyor

Current release info

Version: Anaconda-Server Badge Downloads: Anaconda-Server Badge

Installing sphinx-argparse

Installing sphinx-argparse from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Once the conda-forge channel has been enabled, sphinx-argparse can be installed with:

conda install sphinx-argparse

It is possible to list all of the versions of sphinx-argparse available on your platform with:

conda search sphinx-argparse --channel conda-forge

About conda-forge

conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.

A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by CircleCI, AppVeyor and TravisCI it is possible to build and upload installable packages to the conda-forge Anaconda-Cloud channel for Linux, Windows and OSX respectively.

To manage the continuous integration and simplify feedstock maintenance conda-smithy has been developed. Using the conda-forge.yml within this repository, it is possible to re-render all of this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender.

Terminology

feedstock - the conda recipe (raw material), supporting scripts and CI configuration.

conda-smithy - the tool which helps orchestrate the feedstock. Its primary use is in the construction of the CI .yml files and simplify the management of many feedstocks.

conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)

Updating sphinx-argparse-feedstock

If you would like to improve the sphinx-argparse recipe or build a new package version, please fork this repository and submit a PR. Upon submission, your changes will be run on the appropriate platforms to give the reviewer an opportunity to confirm that the changes result in a successful build. Once merged, the recipe will be re-built and uploaded automatically to the conda-forge channel, whereupon the built conda packages will be available for everybody to install and use from the conda-forge channel. Note that all branches in the conda-forge/sphinx-argparse-feedstock are immediately built and any created packages are uploaded, so PRs should be based on branches in forks and branches in the main repository should only be used to build distinct package versions.

In order to produce a uniquely identifiable distribution:

  • If the version of a package is not being increased, please add or increase the build/number.
  • If the version of a package is being increased, please remember to return the build/number back to 0.