Skip to content

Commit 3007c18

Browse files
jcfrjcfr
committed
docs: Add initial sphinx documentation
1 parent 033c742 commit 3007c18

18 files changed

+1292
-119
lines changed

Diff for: ‎AUTHORS.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Please see the GitHub project page at https://github.com/scikit-build/cmake-python-distributions/graphs/contributors
6+

Diff for: ‎CMakeLists.txt

+1-75
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,7 @@
11
cmake_minimum_required(VERSION 3.6)
22

33
#
4-
# This project has been designed to work with scikit-build.
5-
#
6-
# It allows to create both source and binary distributions of
7-
# CMake.
8-
#
9-
# This is done ensuring source files and build artifacts
10-
# are copied and/or generated in expected locations.
11-
#
12-
# Source distribution (sdist)
13-
# ---------------------------
14-
#
15-
# CMake sources will always be downloaded in the ``<ROOT>/src``
16-
# directory.
17-
#
18-
# This will ensure that the rules specified in ``<ROOT>/MANIFEST.in``
19-
# can successfully glob the source files.
20-
#
21-
# The source distribution is generated using the following
22-
# command::
23-
#
24-
# python setup.pt sdist
25-
#
26-
#
27-
# Binary distribution (build, bdist, bdist_wheel)
28-
# -----------------------------------------------
29-
#
30-
# The project has two mode of operations:
31-
#
32-
# 1. build CMake from source (BUILD_CMAKE_FROM_SOURCE set to ON)
33-
# 2. download CMake binaries (BUILD_CMAKE_FROM_SOURCE set to OFF)
34-
#
35-
#
36-
# Depending on the platform, option ``BUILD_CMAKE_FROM_SOURCE`` has
37-
# different default:
38-
#
39-
# - Linux: ON
40-
# - MacOSX: OFF
41-
# - Windows: OFF
42-
#
43-
# The binary distribution is generated using the following
44-
# command::
45-
#
46-
# python setup.pt bdist_wheel
47-
#
48-
#
49-
# Changing the default mode is achieved by explicitly passing the option
50-
# to CMake::
51-
#
52-
# python setup.pt bdist_wheel -- -DBUILD_CMAKE_FROM_SOURCE:BOOL=ON
53-
#
54-
#
55-
# Optimizations
56-
# -------------
57-
#
58-
# On a given platform, when building different "flavor" of CMake python wheels (one
59-
# for each <python tag>-<abi tag>), the whole process can be made faster by avoiding
60-
# to re-download CMake.
61-
#
62-
# By passing the option ``-DCMakePythonDistributions_ARCHIVE_DOWNLOAD_DIR:PATH=/path/to/cache``,
63-
# successive build will re-use existing archives instead of re-downloading them.
64-
#
65-
# And finally, to avoid rebuilding CMake, the idea is to first create a standalone build
66-
# of the CMake project and then building the wheel using it.
67-
#
68-
# Step 1: Standalone build::
69-
#
70-
# mkdir -p standalone-build && cd $_
71-
# cmake -DCMakePythonDistributions_ARCHIVE_DOWNLOAD_DIR:PATH=/path/to/cache \
72-
# -G Ninja ../
73-
#
74-
# Step 2: Faster build reusing download and build directories::
75-
#
76-
# python setup.py bdist_wheel -- \
77-
# -DCMakePythonDistributions_ARCHIVE_DOWNLOAD_DIR:PATH=/path/to/cache \
78-
# -DCMakeProject_BINARY_DIR:PATH=/path/to/standalone-build
4+
# For more details, see docs/building.rst
795
#
806

817
project(CMakePythonDistributions NONE)

Diff for: ‎CONTRIBUTING.rst

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
Types of Contributions
9+
----------------------
10+
11+
You can contribute in many ways:
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/scikit-build/cmake-python-distributions/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs
25+
~~~~~~~~
26+
27+
Look through the GitHub issues for bugs. Anything tagged with "bug"
28+
is open to whoever wants to implement it.
29+
30+
Implement Features
31+
~~~~~~~~~~~~~~~~~~
32+
33+
Look through the GitHub issues for features. Anything tagged with "feature"
34+
is open to whoever wants to implement it.
35+
36+
Write Documentation
37+
~~~~~~~~~~~~~~~~~~~
38+
39+
The cmake-python-distributions project could always use more documentation. We welcome help
40+
with the official cmake-python-distributions docs, in docstrings, or even on blog posts and
41+
articles for the web.
42+
43+
Submit Feedback
44+
~~~~~~~~~~~~~~~
45+
46+
The best way to send feedback is to file an issue at
47+
https://github.com/scikit-build/cmake-python-distributions/issues.
48+
49+
If you are proposing a new feature:
50+
51+
* Explain in detail how it would work.
52+
* Keep the scope as narrow as possible, to make it easier to implement.
53+
* Remember that this is a volunteer-driven project, and that contributions
54+
are welcome :)
55+
56+
57+
Get Started
58+
-----------
59+
60+
Ready to contribute? Here's how to set up `cmake-python-distributions` for local development.
61+
62+
1. Fork the `cmake-python-distributions` repo on GitHub.
63+
2. Clone your fork locally::
64+
65+
$ git clone [email protected]:your_name_here/cmake-python-distributions.git
66+
67+
3. Install your local copy into a virtualenv. Assuming you have
68+
virtualenvwrapper installed (`pip install virtualenvwrapper`), this is how
69+
you set up your cloned fork for local development::
70+
71+
$ mkvirtualenv cmake-python-distributions
72+
$ cd cmake-python-distributions/
73+
$ pip install -r requirements-dev.txt
74+
75+
4. Create a branch for local development::
76+
77+
$ git checkout -b name-of-your-bugfix-or-feature
78+
79+
Now you can make your changes locally.
80+
81+
5. When you're done making changes, check that your changes pass flake8 and
82+
the tests::
83+
84+
$ flake8
85+
$ python setup.py bdist_wheel
86+
$ python setup.py test
87+
88+
6. Commit your changes and push your branch to GitHub::
89+
90+
$ git add .
91+
$ git commit -m "Your detailed description of your changes."
92+
$ git push origin name-of-your-bugfix-or-feature
93+
94+
7. Submit a pull request through the GitHub website.
95+
96+
97+
Pull Request Guidelines
98+
-----------------------
99+
100+
Before you submit a pull request, check that it meets these guidelines:
101+
102+
1. The pull request should include tests.
103+
104+
2. If the pull request adds functionality, the docs should be updated. Put
105+
your new functionality into a function with a docstring, and add the
106+
feature to the list in `README.rst`.
107+
108+
3. The pull request should work for Python 2.7, and 3.3, 3.4, 3.5.
109+
Check `AppVeyor <https://ci.appveyor.com/project/scikit-build/cmake-python-distributions-f3rbb>`_,
110+
`CircleCI <https://circleci.com/gh/scikit-build/cmake-python-distributions>`_
111+
and `TravisCi <https://travis-ci.org/scikit-build/cmake-python-distributions/pull_requests>`_
112+
and make sure that the tests pass for all supported Python versions.
113+
114+
115+
Tips
116+
----
117+
118+
To run a subset of tests::
119+
120+
$ pytest tests/test_cmake.py

Diff for: ‎HISTORY.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. :changelog:
2+
3+
History
4+
-------
5+
6+
cmake-python-distributions was initially developed in September 2016 by
7+
Jean-Christophe Fillion-Robin to facilitate the distribution of project using
8+
`scikit-build <http://scikit-build.readthedocs.io/>`_ and depending on CMake.

Diff for: ‎README.md

-44
This file was deleted.

Diff for: ‎README.rst

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
==========================
2+
CMake Python Distributions
3+
==========================
4+
5+
.. image:: https://ci.appveyor.com/api/projects/status/439ila0jk7v6uqrr/branch/master?svg=true
6+
:target: https://ci.appveyor.com/project/scikit-build/cmake-python-distributions-f3rbb/branch/master
7+
8+
.. image:: https://circleci.com/gh/scikit-build/cmake-python-distributions.svg?style=svg
9+
:target: https://circleci.com/gh/scikit-build/cmake-python-distributions
10+
11+
.. image:: https://travis-ci.org/scikit-build/cmake-python-distributions.svg?branch=master
12+
:target: https://travis-ci.org/scikit-build/cmake-python-distributions
13+
14+
`CMake <http://www.cmake.org>`_ is used to control the software compilation
15+
process using simple platform and compiler independent configuration files,
16+
and generate native makefiles and workspaces that can be used in the
17+
compiler environment of your choice.
18+
19+
The suite of CMake tools were created by Kitware in response to the need
20+
for a powerful, cross-platform build environment for open-source projects
21+
such as ITK and VTK.
22+
23+
This project is maintained by Jean-Christophe Fillion-Robin from Kitware Inc.
24+
It is covered by the `Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_.
25+
26+
CMake is distributed under the OSI-approved BSD 3-clause License.
27+
For more information about CMake, visit http://cmake.org
28+
29+
* Documentation: http://cmake-python-distributions.readthedocs.io/en/latest/
30+
* Source code: https://github.com/scikit-build/cmake-python-distributions
31+
* Mailing list: https://groups.google.com/forum/#!forum/scikit-build

0 commit comments

Comments
 (0)