Skip to content

Commit b48fe2e

Browse files
geraldbgeraldb
committed
up
1 parent e7b3125 commit b48fe2e

File tree

7 files changed

+192
-0
lines changed

7 files changed

+192
-0
lines changed

‎soldoc/.gitignore

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
*.gem
2+
*.rbc
3+
/.config
4+
/coverage/
5+
/InstalledFiles
6+
/pkg/
7+
/spec/reports/
8+
/test/tmp/
9+
/test/version_tmp/
10+
/tmp/
11+
12+
## Specific to RubyMotion:
13+
.dat*
14+
.repl_history
15+
build/
16+
17+
## Documentation cache and generated files:
18+
/.yardoc/
19+
/_yardoc/
20+
/doc/
21+
/rdoc/
22+
23+
## Environment normalisation:
24+
/.bundle/
25+
/vendor/bundle
26+
/lib/bundler/man/
27+
28+
# for a library or gem, you might want to ignore these files since the code is
29+
# intended to run in multiple environments; otherwise, check them in:
30+
# Gemfile.lock
31+
.ruby-version
32+
.ruby-gemset
33+
34+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
35+
.rvmrc
36+
37+
# Gladiator (Glimmer Editor)
38+
.gladiator
39+
.DS_Store
40+
41+
42+
43+
####
44+
# exclude all tmp & tmp2 and o directory (in all levels)
45+
tmp/
46+
tmp2/
47+
o/
48+
49+
########
50+
# exclude all dbs e.g. artbase.db etc.
51+
*.db
52+
53+
######
54+
# exclude all zips (in /dl)
55+
*.zip
56+
57+
58+

‎soldoc/CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### 0.0.1 / 2023-02-04
2+
3+
* Everything is new. First release

‎soldoc/Manifest.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
CHANGELOG.md
2+
Manifest.txt
3+
README.md
4+
Rakefile
5+
lib/soldoc.rb

‎soldoc/NOTES.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# soldoc Notes
2+
3+
4+
## More
5+
6+
7+
solidity ast
8+
- <https://github.com/OpenZeppelin/solidity-ast> - TypeScript types and a JSON Schema for the Solidity AST
9+
- <https://solidity-ast.netlify.app/>
10+
11+
12+
soldoc links
13+
14+
<https://github.com/OpenZeppelin/solidity-docgen> - Documentation generator for Solidity projects
15+
16+
> The output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.
17+
>
18+
> This is a newer version of the tool that has been rewritten and redesigned. Some more work is pending to ease the transition from the previous version and to help with usage and configuration.
19+
20+
21+
<https://github.com/tsuberim/soldoc> - A documentation generator for solidity projects, inspired by TypeDoc.
22+
<https://www.npmjs.com/package/@soldoc/soldoc>
23+
24+
25+
<https://github.com/HQ20/soldoc> - A solidity documentation generator, based in NatSpec format. with standalone HTML, pdf, gitbook and docsify output just plug and play.
26+
27+
28+
29+
<https://www.npmjs.com/search?q=keywords:natspec>
30+
<https://www.npmjs.com/search?q=keywords:soldoc>
31+
<https://github.com/topics/soldoc>
32+
33+

‎soldoc/README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# soldoc
2+
3+
soldoc gem - command-line tool for solidity (contract) source code documentationn for Ethereum & Co.
4+
5+
6+
* home :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
7+
* bugs :: [github.com/rubycocos/blockchain/issues](https://github.com/rubycocos/blockchain/issues)
8+
* gem :: [rubygems.org/gems/soldoc](https://rubygems.org/gems/soldoc)
9+
* rdoc :: [rubydoc.info/gems/soldoc](http://rubydoc.info/gems/soldoc)
10+
11+
12+
13+
## New to the Solidity (Contract) Programming Language?
14+
15+
See [**Awesome Solidity @ Open Blockchains »**](https://github.com/openblockchains/awesome-solidity)
16+
17+
18+
19+
20+
## Usage
21+
22+
To be done
23+
24+
25+
26+
27+
28+
29+
## Bonus - Awesome Contracts
30+
31+
See the [**Awesome (Ethereum) Contracts / Blockchain Services @ Open Blockchains**](https://github.com/openblockchains/awesome-contracts) repo.
32+
that is a cache of (ethereum) contract ABIs (application binary interfaces)
33+
and open source code (if verified / available)
34+
with auto-generated docs via soldoc & friends.
35+
36+
37+
38+
## License
39+
40+
The scripts are dedicated to the public domain.
41+
Use it as you please with no restrictions whatsoever.
42+
43+
44+
## Questions? Comments?
45+
46+
47+
Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
48+

‎soldoc/Rakefile

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
require 'hoe'
2+
3+
4+
###
5+
# hack/ quick fix for broken intuit_values - overwrite with dummy
6+
class Hoe
7+
def intuit_values( input ); end
8+
end
9+
10+
11+
Hoe.spec 'soldoc' do
12+
13+
self.version = '0.0.1'
14+
15+
self.summary = "soldoc gem - command-line tool for solidity (contract) source code documentationn for Ethereum & Co."
16+
self.description = summary
17+
18+
self.urls = { home: 'https://github.com/rubycocos/blockchain' }
19+
20+
self.author = 'Gerald Bauer'
21+
self.email = '[email protected]'
22+
23+
# switch extension to .markdown for gihub formatting
24+
self.readme_file = 'README.md'
25+
self.history_file = 'CHANGELOG.md'
26+
27+
self.extra_deps = [
28+
['solidity'],
29+
]
30+
31+
self.licenses = ['Public Domain']
32+
33+
self.spec_extras = {
34+
required_ruby_version: '>= 2.3'
35+
}
36+
37+
end
38+

‎soldoc/lib/soldoc.rb

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
require 'solidity'
2+
3+
4+
module Soldoc
5+
end # module Soldoc
6+
7+

0 commit comments

Comments
 (0)