Initial skel.
Ionel Cristian Mărieș
9 years ago
commit
291b229e38
@ -0,0 +1,5 @@
|
||||
[bumpversion]
|
||||
current_version = 0.1.0
|
||||
files = setup.py src/sphinx_py3doc_enhanced_theme.py src/sphinx_py3doc_enhanced_theme/__init__.py
|
||||
commit = True
|
||||
tag = True
|
||||
@ -0,0 +1,53 @@
|
||||
*.py[cod]
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Packages
|
||||
*.egg
|
||||
*.egg-info
|
||||
dist
|
||||
build
|
||||
eggs
|
||||
parts
|
||||
bin
|
||||
var
|
||||
sdist
|
||||
develop-eggs
|
||||
.installed.cfg
|
||||
lib
|
||||
lib64
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
.coverage
|
||||
.tox
|
||||
nosetests.xml
|
||||
htmlcov
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
|
||||
# Mr Developer
|
||||
.mr.developer.cfg
|
||||
.project
|
||||
.pydevproject
|
||||
|
||||
# Complexity
|
||||
output/*.html
|
||||
output/*/index.html
|
||||
|
||||
# Sphinx
|
||||
docs/_build
|
||||
|
||||
.DS_Store
|
||||
*~
|
||||
.*.sw[po]
|
||||
.build/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.ve/
|
||||
.bootstrap/
|
||||
@ -0,0 +1,5 @@
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
* Ionel Cristian Mărieș - http://blog.ionelmc.ro
|
||||
@ -0,0 +1,8 @@
|
||||
|
||||
Changelog
|
||||
=========
|
||||
|
||||
0.1.0 (2014-05-31)
|
||||
-----------------------------------------
|
||||
|
||||
* First release on PyPI.
|
||||
@ -0,0 +1,99 @@
|
||||
============
|
||||
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/ionelmc/sphinx-py3doc-enhanced-theme/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
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Enhanced theme based on py3 documentation's theme could always use more documentation, whether as part of the
|
||||
official Enhanced theme based on py3 documentation's theme 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/ionelmc/sphinx-py3doc-enhanced-theme/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-py3doc-enhanced-theme` for local development.
|
||||
|
||||
1. Fork the `sphinx-py3doc-enhanced-theme` repo on GitHub.
|
||||
2. Clone your fork locally::
|
||||
|
||||
git clone git@github.com:your_name_here/sphinx-py3doc-enhanced-theme.git
|
||||
|
||||
3. Create a branch for local development::
|
||||
|
||||
git checkout -b name-of-your-bugfix-or-feature
|
||||
|
||||
Now you can make your changes locally.
|
||||
|
||||
4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.org/en/latest/install.html>`_::
|
||||
|
||||
tox
|
||||
|
||||
5. 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
|
||||
|
||||
6. 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 passing tests.
|
||||
2. If the pull request adds functionality, the docs should be updated. Make sure that the new code has docstrings and
|
||||
it's included in the reference. Add a note to `CHANGELOG.rst` about the changes.
|
||||
3. Run the tests with ``tox``. If you don't have all the necessary python versions available locally you can take a look
|
||||
at https://travis-ci.org/ionelmc/sphinx-py3doc-enhanced-theme/pull_requests and make sure
|
||||
everything passes.
|
||||
|
||||
Tips
|
||||
----
|
||||
|
||||
To run a subset of tests::
|
||||
|
||||
tox -e envname -- pytest -k test_myfeature
|
||||
@ -0,0 +1,19 @@
|
||||
Copyright (c) 2014, Ionel Cristian Mărieș
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
|
||||
following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
|
||||
disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
|
||||
disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||||
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
||||
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
@ -0,0 +1,23 @@
|
||||
exclude .travis* .cache*
|
||||
|
||||
global-exclude *.py[co]
|
||||
|
||||
graft docs
|
||||
graft examples
|
||||
graft src
|
||||
graft tests
|
||||
|
||||
include *.komodoproject
|
||||
include .bumpversion.cfg
|
||||
include .coveragerc
|
||||
include .isort.cfg
|
||||
include .pylintrc
|
||||
|
||||
include AUTHORS.rst
|
||||
include CHANGELOG.rst
|
||||
include CONTRIBUTING.rst
|
||||
include LICENSE
|
||||
include README.rst
|
||||
|
||||
include configure
|
||||
include tox*.ini
|
||||
@ -0,0 +1,44 @@
|
||||
===============================
|
||||
Enhanced theme based on py3 documentation's theme
|
||||
===============================
|
||||
|
||||
|
||||
.. image:: http://img.shields.io/travis/ionelmc/sphinx-py3doc-enhanced-theme/master.png
|
||||
:alt: Build Status
|
||||
:target: https://travis-ci.org/ionelmc/sphinx-py3doc-enhanced-theme
|
||||
|
||||
.. image:: http://img.shields.io/coveralls/ionelmc/sphinx-py3doc-enhanced-theme.png
|
||||
:alt: Coverage Status
|
||||
:target: https://coveralls.io/r/ionelmc/sphinx-py3doc-enhanced-theme
|
||||
|
||||
.. image:: http://img.shields.io/pypi/v/sphinx_py3doc_enhanced_theme.png
|
||||
:alt: PYPI Package
|
||||
:target: https://pypi.python.org/pypi/sphinx_py3doc_enhanced_theme
|
||||
|
||||
.. image:: http://img.shields.io/pypi/dm/sphinx_py3doc_enhanced_theme.png
|
||||
:alt: PYPI Package
|
||||
:target: https://pypi.python.org/pypi/sphinx_py3doc_enhanced_theme
|
||||
|
||||
A theme based on the theme of https://docs.python.org/3/
|
||||
|
||||
* Free software: BSD license
|
||||
* Documentation: http://sphinx-py3doc-enhanced-theme.readthedocs.org.
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
::
|
||||
|
||||
pip install sphinx_py3doc_enhanced_theme
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
https://sphinx-py3doc-enhanced-theme.readthedocs.org/
|
||||
|
||||
Development
|
||||
===========
|
||||
|
||||
To run the all tests run::
|
||||
|
||||
tox
|
||||
@ -0,0 +1,63 @@
|
||||
# -*- encoding: utf8 -*-
|
||||
import glob
|
||||
import io
|
||||
import re
|
||||
from os.path import basename
|
||||
from os.path import dirname
|
||||
from os.path import join
|
||||
from os.path import splitext
|
||||
|
||||
from setuptools import find_packages
|
||||
from setuptools import setup
|
||||
|
||||
|
||||
def read(*names, **kwargs):
|
||||
return io.open(
|
||||
join(dirname(__file__), *names),
|
||||
encoding=kwargs.get("encoding", "utf8")
|
||||
).read()
|
||||
|
||||
setup(
|
||||
name="sphinx_py3doc_enhanced_theme",
|
||||
version="0.1.0",
|
||||
license="BSD",
|
||||
description="A theme based on the theme of https://docs.python.org/3/",
|
||||
long_description="%s\n%s" % (read("README.rst"), re.sub(":obj:`~?(.*?)`", r"``\1``", read("CHANGELOG.rst"))),
|
||||
author="Ionel Cristian Mărieș",
|
||||
author_email="contact@ionelmc.ro",
|
||||
url="https://github.com/ionelmc/sphinx-py3doc-enhanced-theme",
|
||||
packages=find_packages("src"),
|
||||
package_dir={"": "src"},
|
||||
py_modules=[splitext(basename(i))[0] for i in glob.glob("src/*.py")],
|
||||
include_package_data=True,
|
||||
zip_safe=False,
|
||||
classifiers=[
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: BSD License",
|
||||
"Operating System :: Unix",
|
||||
"Operating System :: POSIX",
|
||||
"Operating System :: Microsoft :: Windows",
|
||||
"Programming Language :: Python",
|
||||
"Programming Language :: Python :: 2.6",
|
||||
"Programming Language :: Python :: 2.7",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.3",
|
||||
"Programming Language :: Python :: 3.4",
|
||||
"Programming Language :: Python :: Implementation :: CPython",
|
||||
"Programming Language :: Python :: Implementation :: PyPy",
|
||||
"Topic :: Utilities",
|
||||
],
|
||||
keywords=[
|
||||
],
|
||||
install_requires=[
|
||||
],
|
||||
extras_require={
|
||||
},
|
||||
entry_points={
|
||||
"console_scripts": [
|
||||
"sphinx_py3doc_enhanced_theme = sphinx_py3doc_enhanced_theme:main"
|
||||
]
|
||||
}
|
||||
|
||||
)
|
||||
@ -0,0 +1,7 @@
|
||||
import os
|
||||
|
||||
__version__ = "0.1.0"
|
||||
|
||||
|
||||
def get_html_theme_path():
|
||||
return os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
|
||||
Loading…
Reference in New Issue