8000 Rename all the things · PaulEcoffet/python_example@cf9a89e · GitHub
[go: up one dir, main page]
Skip to content

Commit cf9a89e

Browse files
SylvainCorlaySylvainCorlay
committed
Rename all the things
1 parent 0deadf0 commit cf9a89e

File tree

10 files changed

+34
-34
lines changed

10 files changed

+34
-34
lines changed

‎README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pbtest
2-
======
1+
python_example
2+
==============
33

44
An example project built with [pybind11](https://github.com/pybind/pybind11).
55

@@ -9,13 +9,13 @@ Installation
99
**On Unix (Linux, OS X)**
1010

1111
- clone this repository
12-
- `pip install ./pbtest`
12+
- `pip install ./python_example`
1313

1414
**On Windows (Requires Visual Studio 2015)**
1515

1616
- For Python 3.5:
1717
- clone this repository
18-
- `pip install ./pbtest`
18+
- `pip install ./pyton_example`
1919
- For earlier versions of Python, including Python 2.7:
2020

2121
Pybind11 requires a C++11 compliant compiler (i.e. Visual Studio 2015 on
@@ -27,9 +27,9 @@ Installation
2727
- `"%VS140COMNTOOLS%\..\..\VC\vcvarsall.bat" x64`
2828
- `set DISTUTILS_USE_SDK=1`
2929
- `set MSSdk=1`
30-
- `pip install ./pbtest`
30+
- `pip install ./python_example`
3131

32-
Note that this requires the user building pbtest to have registry edition
32+
Note that this requires the user building `python_example` to have registry edition
3333
rights on the machine, to be able to run the `vcvarsall.bat` script.
3434

3535

@@ -64,7 +64,7 @@ the extension module to generate beautiful documentation in a variety formats.
6464
The following command generates HTML-based reference documentation; for other
6565
formats please refer to the Sphinx manual:
6666
67-
- `cd pbtest/docs`
67+
- `cd python_example/docs`
6868
- `make html`
6969

7070
License
@@ -78,6 +78,6 @@ Test call
7878
---------
7979

8080
```python
81-
import pbtest
82-
pbtest.add(1, 2)
81+
import python_example
82+
python_example.add(1, 2)
8383
```

‎conda.recipe/meta.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
package:
2-
name: pbtest
2+
name: python_example
33
version: {{ environ.get('GIT_DESCRIBE_TAG', '') }}
44

55
build:
@@ -22,7 +22,7 @@ requirements:
2222

2323
test:
2424
imports:
25-
- pbtest
25+
- python_example
2626

2727
about:
2828
summary: An example project built with pybind11.

‎docs/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ qthelp:
9494
@echo
9595
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
9696
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
97-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pbtest.qhcp"
97+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python_example.qhcp"
9898
@echo "To view the help file:"
99-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pbtest.qhc"
99+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python_example.qhc"
100100

101101
.PHONY: applehelp
102102
applehelp:
@@ -113,8 +113,8 @@ devhelp:
113113
@echo
114114
@echo "Build finished."
115115
@echo "To view the help file:"
116-
@echo "# mkdir -p $$HOME/.local/share/devhelp/pbtest"
117-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pbtest"
116+
@echo "# mkdir -p $$HOME/.local/share/devhelp/python_example"
117+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python_example"
118118
@echo "# devhelp"
119119

120120
.PHONY: epub

‎docs/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# pbtest documentation build configuration file, created by
3+
# python_exameple documentation build configuration file, created by
44
# sphinx-quickstart on Fri Feb 26 00:29:33 2016.
55
#
66
# This file is execfile()d with the current directory set to its
@@ -52,7 +52,7 @@
5252
master_doc = 'index'
5353

5454
# General information about the project.
55-
project = u'pbtest'
55+
project = u'python_example'
5656
copyright = u'2016, Sylvain Corlay'
5757
author = u'Sylvain Corlay'
5858

@@ -206,7 +206,7 @@
206206
#html_search_scorer = 'scorer.js'
207207

208208
# Output file base name for HTML help builder.
209-
htmlhelp_basename = 'pbtestdoc'
209+
htmlhelp_basename = 'python_exampledoc'
210210

211211
# -- Options for LaTeX output ---------------------------------------------
212212

@@ -228,7 +228,7 @@
228228
# (source start file, target name, title,
229229
# author, documentclass [howto, manual, or own class]).
230230
latex_documents = [
231-
(master_doc, 'pbtest.tex', u'pbtest Documentation',
231+
(master_doc, 'python_example.tex', u'python_example Documentation',
232232
u'Sylvain Corlay', 'manual'),
233233
]
234234

@@ -258,7 +258,7 @@
258258
# One entry per manual page. List of tuples
259259
# (source start file, name, description, authors, manual section).
260260
man_pages = [
261-
(master_doc, 'pbtest', u'pbtest Documentation',
261+
(master_doc, 'python_example', u'python_example Documentation',
262262
[author], 1)
263263
]
264264

@@ -272,8 +272,8 @@
272272
# (source start file, target name, title, author,
273273
# dir menu entry, description, category)
274274
texinfo_documents = [
275-
(master_doc, 'pbtest', u'pbtest Documentation',
276-
author, 'pbtest', 'One line description of project.',
275+
(master_doc, 'python_example', u'python_example Documentation',
276+
author, 'python_example', 'One line description of project.',
277277
'Miscellaneous'),
278278
]
279279

‎docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
PBTest Documentation
2-
====================
1+
python_example Documentation
2+
============================
33

44
Contents:
55

66
.. toctree::
77
:maxdepth: 2
88

9-
pbtest
9+
python_example
1010

‎docs/make.bat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@ if "%1" == "qthelp" (
127127
echo.
128128
echo.Build finished; now you can run "qcollectiongenerator" with the ^
129129
.qhcp project file in %BUILDDIR%/qthelp, like this:
130-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pbtest.qhcp
130+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python_example.qhcp
131131
echo.To view the help file:
132-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pbtest.ghc
132+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python_example.ghc
133133
goto end
134134
)
135135

‎docs/pbtest.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/python_example.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. automodule:: python_example

‎py/main.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ int subtract(int i, int j) {
1010

1111
namespace py = pybind11;
1212

13-
PYBIND11_PLUGIN(pbtest) {
14-
py::module m("pbtest", R"pbdoc(
13+
PYBIND11_PLUGIN(python_example) {
14+
py::module m("python_example", R"pbdoc(
1515
Pybind11 example plugin
1616
-----------------------
1717
18-
.. currentmodule:: pbtest
18+
.. currentmodule:: python_example
1919
2020
.. autosummary::
2121
:toctree: _generate

‎setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def __str__(self):
2121

2222
ext_modules = [
2323
Extension(
24-
'pbtest',
24+
'python_example',
2525
['py/main.cpp'],
2626
include_dirs=[
2727
# Path to pybind11 headers
@@ -85,11 +85,11 @@ def build_extensions(self):
8585
build_ext.build_extensions(self)
8686

8787
setup(
88-
name='pbtest',
88+
name='python_example',
8989
version='0.0.1',
9090
author='Sylvain Corlay',
9191
author_email='sylvain.corlay@gmail.com',
92-
url='https://github.com/pybind/pbtest',
92+
url='https://github.com/pybind/python_example',
9393
description='A test project using pybind11',
9494
long_description='',
9595
ext_modules=ext_modules,

0 commit comments

Comments
 (0)
0