Skip to content

Commit

Permalink
Merge branch 'master' into agj/format-webpack-js
Browse files Browse the repository at this point in the history
  • Loading branch information
agjohnson authored Aug 22, 2019
2 parents 2d87454 + 5ba05cd commit b3143a5
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 6 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
*.map
.ropeproject/
.ruby-version
bin/
dist/
bower_components/
include/
Expand Down
20 changes: 20 additions & 0 deletions bin/preinstall.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/usr/bin/env node

const package = require('../package.json');

// Sorry everyone, this is the closest we can get to commenting on package.json
// dependencies :(
if (package.devDependencies['bourbon-neat'] !== '~1.9') {
// Wyrm is not compatible with Neat 2.0+, and Neat 1.9 at least pins a
// node-sass version that doesn't require Python 2. The changes to Wyrm to
// support Neat 2.0+ are all fairly minor changes, but it deeply affects the
// grid system and might be more of a liability than an old release of Neat.
// See: https://github.com/readthedocs/sphinx_rtd_theme/pull/771
console.error(
'bourbon-neat 1.9 is required, Wyrm is not compatible with Neat 2.0+.'
);
console.error(
'The expected selector for the bourbon-neat dependency in package.json is "~1.9".'
);
process.exit(1);
}
67 changes: 67 additions & 0 deletions docs/demo/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,73 @@ C++ API

Some cpp class

.. cpp:member:: float Sphinx::version

The description of Sphinx::version.

.. cpp:var:: int version

The description of version.

.. cpp:type:: std::vector<int> List

The description of List type.

.. cpp:enum:: MyEnum

An unscoped enum.

.. cpp:enumerator:: A

.. cpp:enum-class:: MyScopedEnum

A scoped enum.

.. cpp:enumerator:: B

.. cpp:enum-struct:: protected MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type

A scoped enum with non-default visibility, and with a specified underlying type.

.. cpp:enumerator:: B


JavaScript API
==============

.. Copied from sphinx-doc/sphinx/tests/roots
.. js:module:: module_a.submodule

* Link to :js:class:`ModTopLevel`

.. js:class:: ModTopLevel

* Link to :js:meth:`mod_child_1`
* Link to :js:meth:`ModTopLevel.mod_child_1`

.. js:method:: ModTopLevel.mod_child_1

* Link to :js:meth:`mod_child_2`

.. js:method:: ModTopLevel.mod_child_2

* Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1`

.. js:module:: module_b.submodule

* Link to :js:class:`ModTopLevel`

.. js:class:: ModNested

.. js:method:: nested_child_1

* Link to :js:meth:`nested_child_2`

.. js:method:: nested_child_2

* Link to :js:meth:`nested_child_1`


Generated Index
===============
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"private": true,
"scripts": {
"dev": "webpack-dev-server --open --config webpack.dev.js",
"build": "webpack --config webpack.prod.js"
"build": "webpack --config webpack.prod.js",
"preinstall": "bin/preinstall.js"
},
"dependencies": {},
"devDependencies": {
Expand Down
4 changes: 0 additions & 4 deletions sphinx_rtd_theme/versions.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
</dd>
</dl>
<hr/>
{% trans %}Free document hosting provided by{% endtrans %} <a href="http://www.readthedocs.org">Read the Docs</a>.

</div>
</div>
{% endif %}

0 comments on commit b3143a5

Please sign in to comment.