...
 
Commits (3)
# Credits
- Roland Singer <roland@manjaro.org>
- Esclapion
- Philip Müller <philm@manjaro.org>
- Ramon Buldó <ramon@manjaro.org>
- Hugo Posnic <huluti@manjaro.org>
- Frede Hundewadt <echo ZmhAbWFuamFyby5vcmcK | base64 -d>
Thank you all! ;)
=======
Credits
=======
Development Lead
----------------
* Roland Singer <roland@manjaro.org>
* Esclapion
* philm
* Ramon Buldó <rbuldo@gmail.com>
Contributors
------------
Manjaro-Arm
* dodgejcr
This diff is collapsed.
# Contributing
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.
You can contribute in many ways:
## Types of Contributions
### Report Bugs
Report bugs at [Manjaro Gitlab](https://gitlab.manjaro.org/applications/pacman-mirrors/issues).
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
### Fix Bugs
Look through the Gitlab issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.
### Implement Features
Look through the Gitlab issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.
### Write Documentation
pacman-mirrors could always use more documentation, whether as part of the
official pacman-mirrors docs, in docstrings, or even on the web in blog posts,
articles, and such.
### Translations
Help us to ship pacman-mirrors in your language by helping our translators on [Transifex](https://www.transifex.com/manjarolinux/manjaro-pacman-mirrors/dashboard/).
### Submit Feedback
The best way to send feedback is to file an issue at [Manjaro Gitlab](https://gitlab.manjaro.org/applications/pacman-mirrors/issues).
If you are proposing a feature:
* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)
## Get Started!
Ready to contribute? Here's how to set up `pacman-mirrors` for local development.
* Fork the `pacman-mirrors` repo on GitHub.
* Clone your fork locally:
```
$ git clone https://gitlab.manjaro.org/your-name-here/pacman-mirrors.git
```
* Install your local copy into a virtualenv. Assuming you have [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) installed, this is how you set up your fork for local development
```
$ mkvirtualenv pacman-mirrors
$ cd pacman-mirrors/
$ python setup.py develop
```
* Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
* When you're done making changes, check that your changes pass flake8 and the tests:
```
$ flake8 pacman-mirrors tests
$ python setup.py test
```
* To get flake8, just pip install it into your virtualenv (see notes below).
* Commit your changes and push your branch to GitHub:
```
$ git add
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
```
* Submit a pull request through the GitHub website.
## Test Guidelines
```
make test
```
### Generated Mirrorlist Verification
From experience it is so easy to forget verification of the generated mirrorlists.
As the mirrorlists can be generated in a variety of ways - a list of verifications is presented here.
1. `sudo pacman-mirrors -c all`
2. `sudo pacman-mirrors -f`
3. `sudo pacman-mirrors -c Germany`
4. `sudo pacman-mirrors -c Germany -i`
5. `sudo pacman-mirrors -aP https -c Germany`
6. `sudo pacman-mirrors -aP https http -c Germany -i`
7. `sudo pacman-mirrors -aP http https -c Germany -i`
8. `sudo pacman-mirrors -aP https http -c Germany`
9. `sudo pacman-mirrors -aP http https -c Germany`
All urls in the mirrorlist **must** end with **$repo/$arch**
## Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
* The pull request should include tests.
* If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.md.
* The pull request should work for Python 3.4+, and for PyPy. Check
https://travis-ci.org/manjaro/pacman-mirrors/pull_requests
and make sure that the tests pass for all supported Python versions.
## Tips
To run a subset of tests:
```
$ python -m unittest tests.test_pacman_mirrors
```
## Developing environment
* An editor of choice e.g.
* Visual Studio Code `yay -S visual-studio-code`
* PyCharm Community `pacman -Syu pycharm-community`
* Pandoc converter `pacman -Syu pandoc`
* Python environment
```
$ git clone https://gitlab.manjaro.org/applications/pacman-mirrors.git
$ cd pacman-mirrors
$ sudo pacman -Syu python-pip python-virtualenvwrapper
$ mkvirtualenv pacman-mirrors
$ python setup.py develop
$ pip install mkdocs coverage babel flake8 npyscreen transifex-client
```
* Remember to `source /usr/bin/virtualenvwrapper.sh` to get the virtualenv CLI
============
Contributing
============
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
----------------------
Report Bugs
~~~~~~~~~~~
Report bugs at https://github.com/manjaro/pacman-mirrors/issues.
If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
Fix Bugs
~~~~~~~~
Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.
Implement Features
~~~~~~~~~~~~~~~~~~
Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~
pacman-mirrors could always use more documentation, whether as part of the
official pacman-mirrors docs, in docstrings, or even on the web in blog posts,
articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at https://github.com/manjaro/pacman-mirrors/issues.
If you are proposing a feature:
* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)
Get Started!
------------
Ready to contribute? Here's how to set up `pacman-mirrors` for local development.
1. Fork the `pacman-mirrors` repo on GitHub.
2. Clone your fork locally::
$ git clone git@github.com:your_name_here/pacman-mirrors.git
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
$ mkvirtualenv pacman-mirrors
$ cd pacman-mirrors/
$ python setup.py develop
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
$ flake8 pacman-mirrors tests
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to GitHub::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.
Pull Request Guidelines
-----------------------
Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 3.4+, and for PyPy. Check
https://travis-ci.org/manjaro/pacman-mirrors/pull_requests
and make sure that the tests pass for all supported Python versions.
Tips
----
To run a subset of tests::
$ python -m unittest tests.test_pacman_mirrors
.. :changelog:
History
-------
2.0 (2016-03-01)
---------------------
* Add translation support.
* Better error messages.
* --no-update option, to prevent updates when upgrading the package.
* Big refractor of code.
* Configuration file /etc/pacman-mirrors.conf is optional.
* Pep8 all the code in pacman_mirrors.py
* Reestructure the project.
* The Custom country created with interactive mode is now stored in /var/lib/pacman-mirrors/
* If a Custom country is found in /etc/pacman.d/mirrors/ its moved automatically to the new directory.
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include AUTHORS.md
include CONTRIBUTING.md
include CHANGELOG.md
include LICENSE
include README.rst
include data/mirrors/*
include README.md
include man/pacman-mirrors.8
include share/mirrors.json
include scripts/pacman-mirrors
recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
recursive-include docs *.rst conf.py Makefile make.bat
recursive-include docs *.md
......@@ -7,15 +7,14 @@ help:
@echo "clean-test - remove test and coverage artifacts"
@echo "lint - check style with flake8"
@echo "test - run tests quickly with the default Python"
@echo "test-all - run tests on every Python version with tox"
@echo "coverage - check code coverage quickly with the default Python"
@echo "docs - generate Sphinx HTML documentation, including API docs"
@echo "docs - generate MkDocs HTML documentation, man page using Pandoc, including API docs"
@echo "release - package and upload a release"
@echo "dist - package"
@echo "install - install the package to the active Python's site-packages"
@echo "pot-file - extract messages to locale/pacman_mirrors.pot"
@echo "push-pot - push pot file to transifex"
@echo "pull-pot - pull all translations from transifex"
@echo "pull-po - pull all translations from transifex"
@echo "mo-files - generate .mo files"
clean: clean-build clean-pyc clean-test
......@@ -34,7 +33,6 @@ clean-pyc:
find . -name '__pycache__' -exec rm -fr {} +
clean-test:
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
......@@ -44,22 +42,21 @@ lint:
test:
python setup.py test
test-all:
tox
coverage:
coverage run --source pacman_mirrors setup.py test
coverage report -m
coverage html
open htmlcov/index.html
firefox htmlcov/index.html
docs:
rm -f docs/pacman-mirrors.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ pacman-mirrors
$(MAKE) -C docs clean
$(MAKE) -C docs html
open docs/_build/html/index.html
mkdocs build
pandoc -s -t man docs/index.md -o man/pacman-mirrors.8
pandoc docs/index.md -f markdown -t html -s -o man/pacman-mirrors.8.html
gzip man/pacman-mirrors.8 -fq
man-page:
pandoc -s -t man docs/index.md -o man/pacman-mirrors.8
man man/pacman-mirrors.8
release: clean
python setup.py sdist upload
......
# pacman-mirrors
\ No newline at end of file
# pacman-mirrors
[![Build Status](https://travis-ci.org/manjaro/pacman-mirrors.svg?branch=master)](https://travis-ci.org/manjaro/pacman-mirrors)
Package that provides all mirrors for Manjaro Linux.
- Free software: GPL license
## Features
- A GUI for selecting mirror/protocol combinations used to generate a custom list.
- Generate a new mirror list by using several options:
- method : rank or random.
- country : a single, a list or all.
- fasttrack : limited ranked list of `x` up-to-date mirrors.
- geoip : mirrors for country if available.
- Information
- get-branch : get current branch from config
- country-list: list of countries with mirrors
- API
- prefix : prefix for files handled by pacman-mirrors.
- set-branch : set branch from supplied branch option to config
- protocols:
- set protocol limitation in config
- remove protocol limitation from config
## Technologies
pacman-mirrors is build with Python and Gtk3.
===============================
pacman-mirrors
===============================
.. image:: https://img.shields.io/travis/manjaro/pacman-mirrors.svg
:target: https://travis-ci.org/manjaro/pacman-mirrors
Package that provides all mirrors for Manjaro Linux.
* Free software: GPL license
Features
--------
* TODO
......@@ -10,19 +10,18 @@
## 2) random - randomly generate the output mirrorlist
# Method = rank
## Specify to use only mirrors from specific a country.
## Can add multiple countries separated by a comma (ex: Germany,France)
## Empty means all
# OnlyCountry =
## Filename to use when ranking mirrors
## The file must be present in core repo
# TestFile = core.db.tar.gz
## Mirrors directory
# MirrorlistsDir = /etc/pacman.d/mirrors
## Define protocols and priority
## separated by comma 'https,http' or 'http,https'
## ATM available protocols are: http, https, ftp
## Not specifying a protocol will ban the protocol from being used
## If a mirror has more than one protocol defined only the first is written to the mirrorlist
## Empty means all in reversed alphabetic order
# Protocols =
## Output file
# OutputMirrorlist = /etc/pacman.d/mirrorlist
## When set to True prevents the regeneration of the mirrorlist if
## pacman-mirrors is invoked with the --no-update argument.
## Useful if you don't want the mirrorlist regenerated after a
## pacman-mirrors package upgrade.
# NoUpdate = False
\ No newline at end of file
## When set to False - all certificates are accepted.
## Use only if you fully trust all ssl-enabled mirrors.
# SSLVerify = True
##
## Pacman Mirrorlist
##
[Denmark]
Server = http://mirror.strits.dk/manjaro-arm/$branch/$arch/$repo
Server = https://www.uex.dk/public/manjaro-arm/$branch/$arch/$repo
Server = https://mirrors.dotsrc.org/manjaro-arm/$branch/$arch/$repo
##
## Pacman Mirrorlist
##
[Switzerland]
Server = https://mirror.scachemaille.ch/manjaro-arm/$branch/$arch/$repo
##
## Pacman Mirrorlist
##
[United_States]
Server = http://ftp-osl.osuosl.org/pub/manjaro-arm/repo/$branch/$arch/$repo
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pacman-mirrors.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pacman-mirrors.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pacman-mirrors"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pacman-mirrors"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.. include:: ../AUTHORS.rst
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# pacman-mirrors documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another
# directory, add these directories to sys.path here. If the directory is
# relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# Get the project root dir, which is the parent dir of this
cwd = os.getcwd()
project_root = os.path.dirname(cwd)
# Insert the project root dir as the first element in the PYTHONPATH.
# This lets us ensure that the source package is imported, and that its
# version is used.
sys.path.insert(0, project_root)
import pacman-mirrors
# -- General configuration ---------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'pacman-mirrors'
copyright = u'2015, Ramon Buldó'
# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
# the built documents.
#
# The short X.Y version.
version = pacman-mirrors.__version__
# The full version, including alpha/beta/rc tags.
release = pacman-mirrors.__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to
# some non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built
# documents.
#keep_warnings = False
# -- Options for HTML output -------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a
# theme further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as
# html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the
# top of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon
# of the docs. This file should be a Windows icon file (.ico) being
# 16x16 or 32x32 pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets)
# here, relative to this directory. They are copied after the builtin
# static files, so a file named "default.css" will overwrite the builtin
# "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names
# to template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer.
# Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer.
# Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages
# will contain a <link> tag referring to it. The value of this option
# must be the base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'pacman-mirrorsdoc'
# -- Options for LaTeX output ------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'pacman-mirrors.tex',
u'pacman-mirrors Documentation',
u'Ramon Buldó', 'manual'),
]
# The name of an image file (relative to this directory) to place at
# the top of the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings
# are parts, not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pacman-mirrors',
u'pacman-mirrors Documentation',
[u'Ramon Buldó'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ----------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'pacman-mirrors',
u'pacman-mirrors Documentation',
u'Ramon Buldó',
'pacman-mirrors',
'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
.. include:: ../CONTRIBUTING.rst
.. include:: ../HISTORY.rst
This diff is collapsed.
.. pacman-mirrors documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pacman-mirrors's documentation!
======================================
Contents:
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
authors
history
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
============
Installation
============
# Installation
At the command line::
At the command line:
$ easy_install pacman-mirrors
......
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pacman-mirrors.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pacman-mirrors.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
:end
.. include:: ../README.rst
# Usage
To use pacman-mirrors in a Python project:
import pacman_mirrors
========
Usage
========
To use pacman-mirrors in a project::
import pacman-mirrors
# Translations template for pacman-mirrors.
# Copyright (C) 2017 ORGANIZATION
# This file is distributed under the same license as the pacman-mirrors
# project.
#
# Translators:
msgid ""
msgstr ""
"Project-Id-Version: manjaro-pacman-mirrors\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2017-10-23 20:55+0200\n"
"PO-Revision-Date: 2015-12-22 01:50+0000\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: Azerbaijani (Azerbaijan) (http://www.transifex.com/manjarolinux/manjaro-pacman-mirrors/language/az_AZ/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.5.1\n"
"Language: az_AZ\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: pacman_mirrors/constants/txt.py:29
msgid "ERROR"
msgstr ""
#: pacman_mirrors/constants/txt.py:30
msgid "INFO"
msgstr ""
#: pacman_mirrors/constants/txt.py:31
msgid "WARNING"
msgstr ""
#: pacman_mirrors/constants/txt.py:33
msgid "HTTPException"
msgstr ""
#: pacman_mirrors/constants/txt.py:34
msgid "TIMEOUT"
msgstr ""
#: pacman_mirrors/constants/txt.py:36
msgid "API"
msgstr ""
#: pacman_mirrors/constants/txt.py:37
msgid "BRANCH"
msgstr ""
#: pacman_mirrors/constants/txt.py:38
msgid "COUNTRY"
msgstr ""
#: pacman_mirrors/constants/txt.py:39
msgid "FILE"
msgstr ""
#: pacman_mirrors/constants/txt.py:40
msgid "METHOD"
msgstr ""
#: pacman_mirrors/constants/txt.py:41
msgid "METHODS"
msgstr ""
#: pacman_mirrors/constants/txt.py:42
msgid "MISC"
msgstr ""
#: pacman_mirrors/constants/txt.py:43
msgid "NUMBER"
msgstr ""
#: pacman_mirrors/constants/txt.py:44
msgid "PATH"
msgstr ""
#: pacman_mirrors/constants/txt.py:45
msgid "PREFIX"
msgstr ""
#: pacman_mirrors/constants/txt.py:46
msgid "PROTO"
msgstr ""
#: pacman_mirrors/constants/txt.py:47
msgid "SECONDS"
msgstr ""
#: pacman_mirrors/constants/txt.py:48 pacman_mirrors/constants/txt.py:125
msgid "URL"
msgstr ""
#: pacman_mirrors/constants/txt.py:49
msgid "USAGE"
msgstr ""
#: pacman_mirrors/constants/txt.py:51
msgid "Return branch from configuration"
msgstr ""
#: pacman_mirrors/constants/txt.py:52
msgid "Set prefix to"
msgstr ""
#: pacman_mirrors/constants/txt.py:53
msgid "Replace protocols in configuration"
msgstr ""
#: pacman_mirrors/constants/txt.py:54
msgid "Replace branch in mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:55
msgid "Replace branch in configuration"
msgstr ""
#: pacman_mirrors/constants/txt.py:56
msgid "Replace mirror url in mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:57
msgid "Branch name"
msgstr ""
#: pacman_mirrors/constants/txt.py:58
msgid "Comma separated list of countries, from which mirrors will be used"
msgstr ""
#: pacman_mirrors/constants/txt.py:60
msgid "Load default mirror file"
msgstr ""
#: pacman_mirrors/constants/txt.py:61
msgid "Generate mirrorlist with a number of up-to-date mirrors. Ignores:"
msgstr ""
#: pacman_mirrors/constants/txt.py:63
msgid "Generate mirrorlist with defaults"
msgstr ""
#: pacman_mirrors/constants/txt.py:64
msgid "Get current country using geolocation"
msgstr ""
#: pacman_mirrors/constants/txt.py:65
msgid "List all available countries"
msgstr ""
#: pacman_mirrors/constants/txt.py:66
msgid "Generate custom mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:67
msgid "Generation method"
msgstr ""
#: pacman_mirrors/constants/txt.py:68
msgid "Use to skip generation of mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:69
msgid "Quiet mode - less verbose output"
msgstr ""
#: pacman_mirrors/constants/txt.py:70
msgid "Syncronize pacman databases"
msgstr ""
#: pacman_mirrors/constants/txt.py:71
msgid "Maximum waiting time for server response"
msgstr ""
#: pacman_mirrors/constants/txt.py:72
msgid "Print the pacman-mirrors version"
msgstr ""
#: pacman_mirrors/constants/txt.py:74
msgid "Branch in config is changed"
msgstr ""
#: pacman_mirrors/constants/txt.py:75
msgid "Protocols in config is changed"
msgstr ""
#: pacman_mirrors/constants/txt.py:76
msgid "Re-branch requires a branch to work with"
msgstr ""
#: pacman_mirrors/constants/txt.py:77
msgid "Branch in mirror list is changed"
msgstr ""
#: pacman_mirrors/constants/txt.py:78
msgid "Available countries are"
msgstr ""
#: pacman_mirrors/constants/txt.py:79
msgid "Could not download from"
msgstr ""
#: pacman_mirrors/constants/txt.py:80
msgid "Cannot read file"
msgstr ""
#: pacman_mirrors/constants/txt.py:81
msgid "Cannot write file"
msgstr ""
#: pacman_mirrors/constants/txt.py:82
msgid "Converting custom mirror file to new format"
msgstr ""
#: pacman_mirrors/constants/txt.py:83
msgid "Custom mirror file"
msgstr ""
#: pacman_mirrors/constants/txt.py:84
msgid "Custom mirror file saved"
msgstr ""
#: pacman_mirrors/constants/txt.py:85
msgid "User generated mirror list"
msgstr ""
#: pacman_mirrors/constants/txt.py:86
msgid "Deprecated argument"
msgstr ""
#: pacman_mirrors/constants/txt.py:87
msgid "doesn't exist."
msgstr ""
#: pacman_mirrors/constants/txt.py:88
msgid "Downloading mirrors from"
msgstr ""
#: pacman_mirrors/constants/txt.py:89
msgid "Falling back to"
msgstr ""
#: pacman_mirrors/constants/txt.py:90
msgid "Internet connection appears to be down"
msgstr ""
#: pacman_mirrors/constants/txt.py:91
msgid "Mirror list is generated using random method"
msgstr ""
#: pacman_mirrors/constants/txt.py:92
msgid "is missing"
msgstr ""
#: pacman_mirrors/constants/txt.py:93
msgid "The mirror file"
msgstr ""
#: pacman_mirrors/constants/txt.py:94
msgid "Mirror list generated and saved to"
msgstr ""
#: pacman_mirrors/constants/txt.py:95
msgid "Generated on"
msgstr ""
#: pacman_mirrors/constants/txt.py:96
msgid "custom mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:97
msgid "to reset custom mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:98
msgid "default mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:99
msgid "to modify mirrorlist"
msgstr ""
#: pacman_mirrors/constants/txt.py:100
msgid "Mirror ranking is not available"
msgstr ""
#: pacman_mirrors/constants/txt.py:101
msgid "Must have root privileges"
msgstr ""
#: pacman_mirrors/constants/txt.py:102
msgid "The mirrors has not changed"
msgstr ""
#: pacman_mirrors/constants/txt.py:103
msgid "No mirrors in selection"
msgstr ""
#: pacman_mirrors/constants/txt.py:104