ryanhendricks / doxity-simpleton

Solidity Documentation

Doxity - Simpleton Version

Documentation Generator for Solidity Contracts

Powered by Gatsby

This project is an attempt to create a working version of the @digix/doxity project.

Additional assistance in this fix was gleaned from ProjectWyvern

Getting Started

Clone (or Fork) this repo

git clone https://www.github.com/ryanhendricks/doxity-simpleton.git

Edit the following files to match your Github Repo to use Github Pages

• .doxityrc - no changes needed if you plan to use master branch /docs folder for github pages
• /doxity/config.toml - "linkPrefix = "/doxity-simpleton"" must match your Github Repo
• package.json - the following fields must match your Github Repo to use Github Pages

"author": "Ryan Hendricks",
"main": "docs/index.html",
"repository": {
    "type": "git",
    "url": "git+https://github.com/username/repo.git"
  },
"homepage": "https://github.com/RyanHendricks/doxity-simpleton/",

Add Contracts

Copy solidity contracts to the contracts folder

Build the docs

# install doxity dependencies
cd doxity-simpleton/doxity
yarn
# return to root dir
cd ..
# install project dependencies from root folder
yarn
# build the docs
doxity build

Push your files to Github and Docs should now be available via Github Pages

For a more in depth look at how this works and for additional commands please see: Original Readme

Demo Site

doxity-simpleton's Issues

With truffle.js not compiling

All work fine, but if create file touch truffle.js contracts not compiling: SyntaxError: Error parsing
It don't know interface!

But if delete truffle.js it write interfaces is not a valid file. Skipping.

Wrong paths in html

semantic css link is broken and bundle.js too
But if I change it manually I see blank page.
What could it be?
Edit: I'm trying to run it locally

UnhandledPromiseRejectionWarning: Error: Command failed: solc --combined-json

I have this error, with doxity-simpleton. I use ubuntu 18.04 and yarn. How can i slove this?

Invalid option to --combined-json: clone-bin
(node:5018) UnhandledPromiseRejectionWarning: Error: Command failed: solc --combined-json abi,asm,ast,bin,bin-runtime,clone-bin,devdoc,interface,opcodes,srcmap,srcmap-runtime,userdoc contracts/*
Invalid option to --combined-json: clone-bin

source code configuration gives an error

I've setup and configured the project, all other things works properly. But I want to show the source code of smart contract to on web pages.
As per Doxity documentation, I have modified the .doxityrc file as

{
  "target": "doxity",
  "src": "contracts/*",
  "dir": "pages/docs",
  "out": "docs",
   "whitelist": {
    // the keyname `all` will be used for whitelist defaults
    "all": {
      "abi": true,
      "methods": true,
      "bytecode": false, // bytecode is false or undefined, it won't be shown
      "source": false // source is false or undefined, won't be shown
    },
    "DigixMath": {
      "source": true // source code uniquely shown for this contract, bytecode still hidden
    }
  }
}

Then, when I tried to compile using doxity compile, it gives an error

Error: Output directory /home/admin/documents/doxity-simpleton/scripts/doxity/pages/docs not found, are you in the right directory?
    at Object.exports.default [as compile] (/home/admin/.nvm/versions/node/v8.11.3/lib/node_modules/@digix/doxity/lib/compile/index.js:12:11)
    at Object.wrappedMethods.(anonymous function) [as compile] (/home/admin/.nvm/versions/node/v8.11.3/lib/node_modules/@digix/doxity/lib/index.js:71:24)
    at Object.<anonymous> (/home/admin/.nvm/versions/node/v8.11.3/lib/node_modules/@digix/doxity/lib/bin/doxity.js:35:28)
    at Module._compile (module.js:652:30)
    at Object.Module._extensions..js (module.js:663:10)
    at Module.load (module.js:565:32)
    at tryModuleLoad (module.js:505:12)
    at Function.Module._load (module.js:497:3)
    at Function.Module.runMain (module.js:693:10)
    at startup (bootstrap_node.js:191:16)
    at bootstrap_node.js:612:3

If I revert it and then check again, it is working fine.. any help to show the source code ?