Skip to content

Commit

Permalink
Reorganize source tree.
Browse files Browse the repository at this point in the history
doc -> docs, put relstorage into a src/ directory to avoid issues having the working directory on the path.

Fixes #218
  • Loading branch information
jamadden committed May 10, 2019
1 parent 970444d commit d33fb33
Show file tree
Hide file tree
Showing 163 changed files with 54 additions and 24 deletions.
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ include/
lib/
parts/

doc/_build/
doc/__pycache__
doc/relstorage.*.rst
docs/_build/
docs/__pycache__
docs/relstorage.*.rst
26 changes: 26 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Some things can only be configured on the RTD dashboard.
# Those that we may have changed from the default include:

# Show Version Warning: False

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/conf.py

# Set the version of Python and requirements required to build your
# docs
python:
version: 3
install:
- method: pip
path: .
extra_requirements:
- docs
10 changes: 4 additions & 6 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include MANIFEST.in *.txt *.py setup.cfg
include MANIFEST.in *.txt *.py *.yml setup.cfg
include .coveragerc
include buildout*.cfg
include tox.ini
Expand All @@ -9,12 +9,10 @@ include CHANGES.rst
include .landscape.yml
recursive-include .travis *

recursive-include notes *.ods *.py *.sql *.txt
recursive-include src *.py *.xml *.txt *.test *.conf *.rst *.c *.h

recursive-include relstorage *.py *.xml *.txt *.test *.conf *.rst *.c *.h

recursive-include doc *.py *.rst *.png Makefile
recursive-exclude doc relstorage.*.rst _build
recursive-include docs *.py *.rst *.png Makefile
recursive-exclude docs relstorage.*.rst _build

recursive-include repltest *.cfg *.conf *.in *.patch *.sql
recursive-include scripts *.sh make-manylinux
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
26 changes: 13 additions & 13 deletions doc/conf.py → docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@


try:
import pylibmc
__import__('pylibmc')
except ImportError:
print("Mocking pylibmc for docs")
sys.path.append(".mocks")
Expand Down Expand Up @@ -268,21 +268,21 @@
# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 8 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ def read_file(*path):
'Documentation': 'http://relstorage.readthedocs.io',
},
keywords="ZODB SQL RDBMS MySQL PostgreSQL Oracle",
packages=find_packages(),
packages=find_packages('src'),
package_dir={'': 'src'},
include_package_data=True,
license="ZPL 2.1",
platforms=["any"],
Expand Down Expand Up @@ -99,7 +100,7 @@ def read_file(*path):
# Otherwise, we'll build it at import time. The wheels we distribute should have
# cffi installed so we distribute the built binaries.
cffi_modules=[
'relstorage/cache/_cache_ring_build.py:ffi',
'src/relstorage/cache/_cache_ring_build.py:ffi',
],
tests_require=tests_require,
extras_require={
Expand Down Expand Up @@ -136,6 +137,11 @@ def read_file(*path):
'cx_Oracle>=5.0.0'
],
'test': tests_require,
'docs': [
'sphinxcontrib-programoutput',
'repoze.sphinx.autointerface',
'sphinx_rtd_theme',
],
},
entry_points={
'console_scripts': [
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit d33fb33

Please sign in to comment.