Docgen

[dweng0]

This PR adds the following functionality:

• Auto-generated documentation (must run script to generate the documentation).
• Implements a feature toggle to show or hide content, CSS files, and CSS classes.
• Introduced additional Lua scripts to enhance the auto-generated documentation.

Summary of changes

• moved the scss files to css files as they do not compile properly otherwise.
• contract.py fixes and issue with description being included even if its not available.
• _features.yml is essentially a config file to list files and or classes that should be excluded when compiled.
• The new filters are all designed to provide a better UI experience, for example the access type of a function, or additional details at the foot of the contract's page
• The feature-filter.py script executes post quarto render and removes css files classes based on a list of files and classes provided in the _features.yml file.

[dweng0]

This script executes post quarto render and removes css files classes based on a list of files and classes provided in the _features.yml file.

[aiman]

@dweng0

This is a good start, however the branch is using an old commit of master, before the README changes went in, which is not conducive to code review.

Please rebase the branch off the current master, make any necessary changes such as in the README, and then force-push the branch up to Github.

Also, please fix the whitespace errors introduced in this PR. There are already a lot in the repo, but that doesn't mean we should add to the problem!

Check whitespace errors in this PR:

git fetch origin
git checkout docgen
git diff --check origin/master...HEAD

Good resource: Checking whitespace with Git

[github-actions]

🚀 This branch can be previewed at https://59ae9cbc.docs-autonity-org.pages.dev

[dweng0]

Change delta following rebase

The following reverts the GHA workflow and README changes to master branch:

• 7d3d651
• f463a3e

---

The following fixes whitespace issues in the GHA workflows and index.md and /api.index.md

• f152bed
• e5a4e96

[dweng0]

In this ee3fc51 commit i changed a comment in the code to say "css" instead of "scss" to prevent any confusion when used in future.

[szemate]

@aiman I've made the following changes to streamline the build process:

1. Install solc from the Nix store and use it to build the contract ABIs and NatSpec data files before the documents are generated. (e6e0f48)
   • It's a lot faster (~0.5 sec vs. ~20 sec for make contracts)
   • We can be sure that the generated files are in sync with the Autonity source code
   • We don't have to deal with the idiosyncrasies of the Autonity build process
2. Add site-preview and site-render commands (in line with the dashboard repository) that run apidocgen and quarto together if a symlink to Autonity is in the directory. (4c7739f)
   • Unfortunately it isn't possible to use Quarto's pre-render hook because it runs after input files are collected and apidocgen may change the input files.

Let me know what you think.