Skip to content

Commit b3143a5

Browse files
authored
Merge branch 'master' into agj/format-webpack-js
2 parents 2d87454 + 5ba05cd commit b3143a5

File tree

5 files changed

+89
-6
lines changed

5 files changed

+89
-6
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
*.map
1010
.ropeproject/
1111
.ruby-version
12-
bin/
1312
dist/
1413
bower_components/
1514
include/

bin/preinstall.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#!/usr/bin/env node
2+
3+
const package = require('../package.json');
4+
5+
// Sorry everyone, this is the closest we can get to commenting on package.json
6+
// dependencies :(
7+
if (package.devDependencies['bourbon-neat'] !== '~1.9') {
8+
// Wyrm is not compatible with Neat 2.0+, and Neat 1.9 at least pins a
9+
// node-sass version that doesn't require Python 2. The changes to Wyrm to
10+
// support Neat 2.0+ are all fairly minor changes, but it deeply affects the
11+
// grid system and might be more of a liability than an old release of Neat.
12+
// See: https://github.com/readthedocs/sphinx_rtd_theme/pull/771
13+
console.error(
14+
'bourbon-neat 1.9 is required, Wyrm is not compatible with Neat 2.0+.'
15+
);
16+
console.error(
17+
'The expected selector for the bourbon-neat dependency in package.json is "~1.9".'
18+
);
19+
process.exit(1);
20+
}

docs/demo/api.rst

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,73 @@ C++ API
2828

2929
Some cpp class
3030

31+
.. cpp:member:: float Sphinx::version
32+
33+
The description of Sphinx::version.
34+
35+
.. cpp:var:: int version
36+
37+
The description of version.
38+
39+
.. cpp:type:: std::vector<int> List
40+
41+
The description of List type.
42+
43+
.. cpp:enum:: MyEnum
44+
45+
An unscoped enum.
46+
47+
.. cpp:enumerator:: A
48+
49+
.. cpp:enum-class:: MyScopedEnum
50+
51+
A scoped enum.
52+
53+
.. cpp:enumerator:: B
54+
55+
.. cpp:enum-struct:: protected MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type
56+
57+
A scoped enum with non-default visibility, and with a specified underlying type.
58+
59+
.. cpp:enumerator:: B
60+
61+
62+
JavaScript API
63+
==============
64+
65+
.. Copied from sphinx-doc/sphinx/tests/roots
66+
67+
.. js:module:: module_a.submodule
68+
69+
* Link to :js:class:`ModTopLevel`
70+
71+
.. js:class:: ModTopLevel
72+
73+
* Link to :js:meth:`mod_child_1`
74+
* Link to :js:meth:`ModTopLevel.mod_child_1`
75+
76+
.. js:method:: ModTopLevel.mod_child_1
77+
78+
* Link to :js:meth:`mod_child_2`
79+
80+
.. js:method:: ModTopLevel.mod_child_2
81+
82+
* Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1`
83+
84+
.. js:module:: module_b.submodule
85+
86+
* Link to :js:class:`ModTopLevel`
87+
88+
.. js:class:: ModNested
89+
90+
.. js:method:: nested_child_1
91+
92+
* Link to :js:meth:`nested_child_2`
93+
94+
.. js:method:: nested_child_2
95+
96+
* Link to :js:meth:`nested_child_1`
97+
3198

3299
Generated Index
33100
===============

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"private": true,
66
"scripts": {
77
"dev": "webpack-dev-server --open --config webpack.dev.js",
8-
"build": "webpack --config webpack.prod.js"
8+
"build": "webpack --config webpack.prod.js",
9+
"preinstall": "bin/preinstall.js"
910
},
1011
"dependencies": {},
1112
"devDependencies": {

sphinx_rtd_theme/versions.html

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@
2929
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
3030
</dd>
3131
</dl>
32-
<hr/>
33-
{% trans %}Free document hosting provided by{% endtrans %} <a href="http://www.readthedocs.org">Read the Docs</a>.
34-
3532
</div>
3633
</div>
3734
{% endif %}
38-

0 commit comments

Comments
 (0)