sphinx_advanced’s documentation¶
sphinx_advanced¶
Information¶
Sphinx Advanced Example
- Free software: MIT license
- Documentation: https://sphinx-advanced.readthedocs.io.
Credits¶
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Installation¶
Stable release¶
To install sphinx_advanced, run this command in your terminal:
$ pip install sphinx_advanced
This is the preferred method to install sphinx_advanced, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for sphinx_advanced can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/jatap/sphinx_advanced
Or download the tarball:
$ curl -OL https://github.com/jatap/sphinx_advanced/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
sphinx_advanced¶
sphinx_advanced package¶
Submodules¶
sphinx_advanced.calculator module¶
Calculator module
- Usage:
- from sphinx_advanced import calculator
-
sphinx_advanced.calculator.addition(first, second)[source]¶ Addition operation
Parameters: - first – first operator
- second – second operator
- Returns:
- The result of an addition operation
-
sphinx_advanced.calculator.division(first, second)[source]¶ Division operation
Parameters: - first – first operator
- second – second operator
- Returns:
- The result of a division operation
-
sphinx_advanced.calculator.exponential(first, second)[source]¶ Exponential operation
Parameters: - first – first operator
- second – second operator
- Returns:
- The result of a exponential operation
sphinx_advanced.sphinx_advanced module¶
Main module
Note
Proof of Concept
- Usage:
- from sphinx_advanced import sphinx_advanced
-
sphinx_advanced.sphinx_advanced.help()[source]¶ Sphinx Advanced Module help
Todo
Add some subpackage
- Args:
- none
- Retuns:
- A brief description of the module
-
sphinx_advanced.sphinx_advanced.init()[source]¶ Print
help()when run as a script.- Args:
- none
- Retuns:
sphinx_advanced.sphinx_advanced.help()
Module contents¶
Top-level package for sphinx_advanced.
Features¶
Todo
Add some subpackage
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-advanced/envs/stable/lib/python3.5/site-packages/sphinx_advanced-0.3.0-py3.5.egg/sphinx_advanced/sphinx_advanced.py:docstring of sphinx_advanced.sphinx_advanced.help, line 3.)
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/jatap/sphinx_advanced/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” and “help wanted” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation¶
sphinx_advanced could always use more documentation, whether as part of the official sphinx_advanced 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/jatap/sphinx_advanced/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 sphinx_advanced for local development.
Fork the sphinx_advanced repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/sphinx_advanced.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv sphinx_advanced $ cd sphinx_advanced/ $ python setup.py developCreate 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, including testing other Python versions with tox:
$ flake8 sphinx_advanced tests $ python setup.py test or py.test $ toxTo get flake8 and tox, just pip install them into your virtualenv.
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-featureSubmit a pull request through the GitHub website.
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.rst.
- The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/jatap/sphinx_advanced/pull_requests and make sure that the tests pass for all supported Python versions.
Deploying¶
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis will then deploy to PyPI if tests pass.
Credits¶
project = u'sphinx_advanced'
copyright = u"2018, Julio Antúnez Tarín"
Development Lead¶
- Julio Antúnez Tarín <julio.antunez.tarin@gmail.com>
Contributors¶
None yet. Why not be the first?