Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues building static assets #4311

Merged
merged 1 commit into from
Jun 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/development/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,6 @@ To install these tools and dependencies::

npm install

This will install locally to the project, not globally. You can install globally
if you wish, otherwise make sure ``node_modules/.bin`` is in your PATH.

Next, install front end dependencies::

bower install
Expand All @@ -79,19 +76,24 @@ source file that will compile over your changes.
To test changes while developing, which will watch source files for changes and
compile as necessary, you can run `Gulp`_ with our development target::

gulp dev
npm run dev

Once you are satisfied with your changes, finalize the bundles (this will
minify library sources)::

gulp build
npm run build

If you updated any of our vendor libraries, compile those::

gulp vendor
npm run vendor

Make sure to check in both files under ``static`` and ``static-src``.

.. note::

We run Gulp through an ``npm`` script in order to ensure
that the correct version from ``package.json`` is used.

Making Changes
--------------

Expand Down
12 changes: 9 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"version": "0.0.1",
"description": "Read the Docs build dependencies",
"author": "Anthony Johnson <[email protected]>",
"scripts": {
"build": "gulp build",
"dev": "gulp dev",
"lint": "gulp lint",
"vendor": "gulp vendor"
},
"dependencies": {
"bowser": "^1.9.3",
"cssfilter": "0.0.8",
Expand All @@ -22,12 +28,12 @@
"gulp-less": "^3.0.3",
"gulp-rename": "^1.2.2",
"gulp-run": "^1.6.6",
"gulp-uglify": "^1.2.0",
"gulp-uglify": "^3.0.0",
"gulp-util": "^3.0.3",
"gulp-watch": "^4.3.3",
"less": "^2.7.3",
"vinyl-buffer": "^1.0.0",
"vinyl-source-stream": "^1.1.0"
"vinyl-buffer": "^1.0.1",
"vinyl-source-stream": "^2.0.0"
},
"resolutions": {
"natives": "1.1.3"
Expand Down