Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Use TypeDoc Markdown docs for @0x/web3-wrapper #2005

Closed
wants to merge 8 commits into from

Conversation

fabioberger
Copy link
Contributor

Description

We would like to move away from using our own custom-built documentation pages. The first step is to generate TypeDoc Markdown documentation pages for non-essential packages. This PR shows what this will look like by doing it for @0x/web3-wrapper.

Testing instructions

Types of changes

Checklist:

  • Prefix PR title with [WIP] if necessary.
  • Add tests to cover changes as needed.
  • Update documentation as needed.
  • Add new entries to the relevant CHANGELOG.jsons.

@buildsize
Copy link

buildsize bot commented Jul 27, 2019

File name Previous Size New Size Change
init.py 141.32 KB 141.32 KB 0 bytes (0%)
abi_gen_dummy.ts 103.94 KB [deleted]
lib_dummy.ts 4.74 KB [deleted]
test_lib_dummy.ts 11.37 KB [deleted]
environment.pickle 1.56 MB 1.56 MB 0 bytes (0%)
index.doctree 189.53 KB 189.53 KB 0 bytes (0%)
.buildinfo 230 bytes 230 bytes 0 bytes (0%)
genindex.html 5.6 KB 5.6 KB 0 bytes (0%)
index.html 2.52 KB 2.52 KB 0 bytes (0%)
objects.inv 375 bytes 375 bytes 0 bytes (0%)
py-modindex.html 3.07 KB 3.07 KB 0 bytes (0%)
search.html 2.81 KB 2.81 KB 0 bytes (0%)
searchindex.js 5.83 KB 5.83 KB 0 bytes (0%)
index.rst.txt 415 bytes 415 bytes 0 bytes (0%)
alabaster.css 10.92 KB 10.92 KB 0 bytes (0%)
basic.css 11.83 KB 11.83 KB 0 bytes (0%)
custom.css 42 bytes 42 bytes 0 bytes (0%)
doctools.js 9.05 KB 9.05 KB 0 bytes (0%)
documentation_options.js 303 bytes 303 bytes 0 bytes (0%)
file.png 286 bytes 286 bytes 0 bytes (0%)
jquery-[version].js 261.76 KB 261.76 KB 0 bytes (0%)
jquery.js 84.63 KB 84.63 KB 0 bytes (0%)
language_data.js 10.59 KB 10.59 KB 0 bytes (0%)
minus.png 90 bytes 90 bytes 0 bytes (0%)
plus.png 90 bytes 90 bytes 0 bytes (0%)
pygments.css 4.69 KB 4.69 KB 0 bytes (0%)
searchtools.js 15.61 KB 15.61 KB 0 bytes (0%)
underscore-[version].js 34.34 KB 34.34 KB 0 bytes (0%)
underscore.js 11.86 KB 11.86 KB 0 bytes (0%)
contract_addresses.html 16.87 KB 16.87 KB 0 bytes (0%)
contract_artifacts.html 7.94 KB 7.94 KB 0 bytes (0%)
_bootstrap.html 142.73 KB 142.73 KB 0 bytes (0%)
json_schemas.html 12.43 KB 12.43 KB 0 bytes (0%)
order_utils.html 44.87 KB 44.87 KB 0 bytes (0%)
erc20_token.html 80.14 KB 80.14 KB 0 bytes (0%)
exchange.html 458.9 KB 458.9 KB 0 bytes (0%)
tx_params.html 8.83 KB 8.83 KB 0 bytes (0%)
local_message_signer.html 15.07 KB 15.07 KB 0 bytes (0%)
asset_data_utils.html 22.65 KB 22.65 KB 0 bytes (0%)
default_api.html 118.49 KB 118.49 KB 0 bytes (0%)

@coveralls
Copy link

coveralls commented Jul 27, 2019

Coverage Status

Coverage remained the same at 82.127% when pulling fe81b62 on feature/markdownDocs into 78c704e on development.

@fabioberger fabioberger force-pushed the feature/markdownDocs branch 2 times, most recently from 25880a7 to 8af1525 Compare July 29, 2019 20:41
@fabioberger fabioberger force-pushed the feature/markdownDocs branch from 8af1525 to fe81b62 Compare August 3, 2019 14:42
@fabioberger
Copy link
Contributor Author

Supersceded by: #2033

@fabioberger fabioberger closed this Aug 3, 2019
@fabioberger fabioberger deleted the feature/markdownDocs branch September 2, 2019 14:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants