OpenZeppelin / solidity-docgen

Documentation generator for Solidity projects
MIT License
452 stars 118 forks source link

Ignore/exclude specific files or contracts inside files #444

Closed vladikopl01 closed 1 year ago

vladikopl01 commented 1 year ago

Hello!

Is there a possibility to ignore specific contract files by providing a path to them to exclude property in docgen config?

If not, it would be a great feature to have to use contract paths as other plugins for hardhat, as follows:

Also, could someone help me out with excluding contract files in such a way? Or maybe specify somehow a contract file which only should be documented? All contract files are located at contracts/ and it's forbidden to move files in different folders.

Would appreciate any help.

frangio commented 1 year ago

I believe you should be able to have this file excluded by adding to your Hardhat config:

docgen: {
  exclude: ['tokens/Tokens.sol'],
},
vladikopl01 commented 1 year ago

Damn, sorry, definitely a stupid issue from my side. @frangio Thanks, it works