Skip to content

Commit

Permalink
Remove JSDoc tools (MetaMask#7897)
Browse files Browse the repository at this point in the history
Our JSDoc documentation has not been updated in a very long time, and
we don't use JSDoc in enough places for the docs to have been
especially useful. The tools and scripts  used to generate and publish
these docs have been removed.

References to this documentation have also been removed from the
README.

Hopefully once the TypeScript migration has made substantial progress,
we can generate more useful documentation using something like TypeDoc.
  • Loading branch information
Gudahtt authored and yqrashawn committed Feb 10, 2020
1 parent ea41064 commit 886b712
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 246 deletions.
25 changes: 0 additions & 25 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ workflows:
- prep-build-test:
requires:
- prep-deps
# - prep-docs:
# requires:
# - prep-deps
- prep-scss:
requires:
- prep-deps
Expand Down Expand Up @@ -81,7 +78,6 @@ workflows:
requires:
- prep-deps
- prep-build
# - prep-docs
- all-tests-pass
# - job-publish-storybook:
# filters:
Expand Down Expand Up @@ -162,21 +158,6 @@ jobs:
paths:
- dist-test

prep-docs:
docker:
- image: circleci/node:10.17-browsers
steps:
- checkout
- attach_workspace:
at: .
- run:
name: build:dist
command: yarn doc
- persist_to_workspace:
root: .
paths:
- docs/jsdocs

prep-scss:
docker:
- image: circleci/node:10.17-browsers
Expand Down Expand Up @@ -349,12 +330,6 @@ jobs:
- run:
name: Create GitHub Pull Request to sync master with develop
command: .circleci/scripts/release-create-master-pr
# - run:
# name: github gh-pages docs publish
# command: >
# git config --global user.name "metamaskbot" &&
# git config --global user.email "admin@metamask.io" &&
# yarn publish-docs
# job-publish-storybook:
# docker:
# - image: circleci/node:10.17-browsers
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ coverage/
dist
builds/
builds.zip
docs/jsdocs

development/bundle.js
development/states.js
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ Uncompressed builds can be found in `/dist`, compressed builds can be found in `

You can read [our internal docs here](https://conflux-chain.github.io/conflux-portal/).

You can re-generate the docs locally by running `yarn doc`, and contributors can update the hosted docs by running `yarn publish-docs`.

### Running Tests

Run tests with `yarn test`.
Expand Down
25 changes: 0 additions & 25 deletions development/.jsdoc.json

This file was deleted.

5 changes: 0 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
"scripts": {
"start": "gulp dev:extension",
"dist": "gulp dist",
"doc": "jsdoc -c development/.jsdoc.json",
"publish-docs": "gh-pages -d docs/jsdocs",
"start:test": "gulp dev:test",
"benchmark:chrome": "SELENIUM_BROWSER=chrome node test/e2e/benchmark.js",
"benchmark:firefox": "SELENIUM_BROWSER=firefox node test/e2e/benchmark.js",
Expand Down Expand Up @@ -251,7 +249,6 @@
"ganache-core": "2.8.0",
"geckodriver": "^1.19.1",
"get-port": "^5.1.0",
"gh-pages": "^1.2.0",
"gulp": "^4.0.0",
"gulp-autoprefixer": "^5.0.0",
"gulp-babel": "^7.0.0",
Expand All @@ -274,7 +271,6 @@
"http-server": "^0.11.1",
"husky": ">=1",
"isomorphic-fetch": "^2.2.1",
"jsdoc": "^3.6.2",
"jsdom": "^11.2.0",
"jsdom-global": "^3.0.2",
"karma": "^4.1.0",
Expand All @@ -299,7 +295,6 @@
"proxyquire": "2.0.1",
"qs": "^6.2.0",
"qunitjs": "^2.4.1",
"radgrad-jsdoc-template": "^1.1.3",
"react-devtools": "^4.4.0",
"react-test-renderer": "^16.12.0",
"read-installed": "^4.0.3",
Expand Down
Loading

0 comments on commit 886b712

Please sign in to comment.