Added documentation

Author: allRisc

.github/workflows/pages-workflow.yml

@@ -0,0 +1,56 @@
+name: Page Workflow
+
+permissions:
+  id-token: write
+  pages: write
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build-pages:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Prereqs
+        run : |
+          cd ..
+          sudo apt-get update
+          sudo apt install ca-certificates gnupg
+          sudo gpg --homedir /tmp --no-default-keyring --keyring /usr/share/keyrings/mono-official-archive-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
+          echo "deb [signed-by=/usr/share/keyrings/mono-official-archive-keyring.gpg] https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
+          sudo apt update
+          sudo apt-get install -y git curl unzip mono-devel
+          curl -o nd.zip https://www.naturaldocs.org/download/natural_docs/2.3.1/Natural_Docs_2.3.1.zip
+          unzip nd.zip
+          ls
+
+
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Run Natural-Docs
+        run: |
+          ls
+          ls ../Natural\ Docs
+          mono ../Natural\ Docs/NaturalDocs.exe docs/config
+          ls docs
+
+      - name: Upload static files as artifacts
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/html/
+
+  deploy-pages:
+    environment:
+      name: github-pags
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-pages
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -4,4 +4,6 @@
 # Tooling directories
 .dvt/*
 
-
+# Documentation Build Files
+docs/html
+docs/config/Working\ Data/

README.md

@@ -2,12 +2,4 @@
 
 A UVM Agent for the AMBA AHB Protocol
 
-## Usage
-
-```SystemVerilog
-
-class user_env extends uvm_env;
-
-endclass : user env
-
-```
+Documentation can be found: [https://riscy-lib.github.io/ahb_agent/](https://riscy-lib.github.io/ahb_agent/)

docs/config/Comments.txt

@@ -0,0 +1,106 @@
+Format: 2.3.1
+
+# This is the Natural Docs comments file for this project.  If you change
+# anything here, it will apply to THIS PROJECT ONLY.  You can edit the version
+# in Natural Docs' Config folder to make the changes apply to all projects,
+# but it's recommended that you edit this version instead.
+
+
+# Ignored Keywords
+# ------------------------------------------------------------------------
+
+# If you'd like to prevent keywords from being recognized by Natural Docs,
+# you can do it like this:
+#
+# Ignore Keywords:
+#    [keyword]
+#    [keyword]
+#    ...
+
+
+# Comment Types
+# ------------------------------------------------------------------------
+# The syntax reference is after the definitions.
+
+Alter Comment Type: Class
+
+   SystemVerilog Keywords:
+      package, packages
+
+
+Comment Type: Signals
+
+   Display Name: Signal
+   Plural Display Name: Signals
+
+   SystemVerilog Keywords:
+      signal, signals
+
+
+Comment Type: Instances
+
+   Keywords:
+      inst
+      instance, instances
+
+
+# Each Natural Docs comment has a corresponding type which determine its
+# behavior.  You can define your own here or override the settings of the
+# existing ones.
+#
+# Comment Type: [name]
+# Alter Comment Type: [name]
+#    Creates a new comment type or changes an existing one.
+#
+# Display Name: [name]
+# Plural Display Name: [name]
+#    The singular and plural name of the comment type as it should appear in
+#    the output.
+#
+# Simple Identifier: [name]
+#    The name of the comment type using only the letters A to Z.  No spaces,
+#    numbers, symbols, or Unicode allowed.  Defaults to the comment type name
+#    minus any unacceptable characters.  This is used to generate things like
+#    CSS class names.
+#
+# Scope: [normal|start|end|always global]
+#    How the comment affects scope.  Defaults to normal.
+#    normal        - The comment stays within the current scope.
+#    start         - The comment starts a new scope for all the comments
+#                    beneath it, like class comments.
+#    end           - The comment resets the scope back to global for all the
+#                    comments beneath it, like section comments.
+#    always global - The comment is defined as a global symbol, but does not
+#                    change the scope for any other comments.
+#
+# Flags: [flag], [flag], ...
+#    A combination of settings that apply to the comment type.
+#    Code, File, or Documentation
+#        Whether it's used to describe a code element, a file, or is a
+#        standalone documentation comment.  Defaults to Code.
+#    Variable Type
+#        Whether it describes a code element that can be used as a variable's
+#        type.
+#    Class Hierarchy or Database Hierarchy
+#        Whether it describes a code element that should be included in the
+#        class or database hierarchy.  Requires Scope: Start.
+#    Enum
+#        Whether it describes an enum.
+#
+# Keywords:
+#    [keyword]
+#    [keyword], [plural keyword]
+#    ...
+#    A list of the comment type's keywords.  Each line after the heading is
+#    the keyword and optionally its plural form for list comments.  You can
+#    reuse existing keywords to change their definition.  When using
+#    "Alter Comment Type", these keywords are added to the existing ones
+#    rather than replacing them.
+#
+# [Language] Keywords:
+#    [keyword]
+#    [keyword], [plural keyword]
+#    ...
+#    A list of keywords that only apply to the comment type when using a
+#    specific programming language.  Each line after the heading is the
+#    keyword and optionally its plural form for list comments.

docs/config/Languages.txt

@@ -0,0 +1,108 @@
+Format: 2.3.1
+
+# This is the Natural Docs languages file for this project.  If you change
+# anything here, it will apply to THIS PROJECT ONLY.  You can edit the version
+# in Natural Docs' Config folder to make the changes apply to all projects,
+# but it's recommended that you edit this version instead.
+
+
+# Ignored Extensions
+# ------------------------------------------------------------------------
+
+# If you'd like to prevent certain file extensions from being scanned by
+# Natural Docs, you can do it like this:
+#
+# Ignore Extensions: [extension] [extension] ...
+
+
+# Languages
+# ------------------------------------------------------------------------
+# The syntax reference is after the definitions.
+
+Alter Language: SystemVerilog
+
+   Interface Prototype Ender: ;
+   Property Prototype Ender: ;
+   Signals Prototype Enders: ; =
+   Instances Prototype Ender: ;
+
+
+# These settings define the languages Natural Docs knows how to parse.  You
+# can define your own here or override the settings of the existing ones.
+# Note that all lists are space separated so that commas can be used as
+# values.
+#
+# Language: [name]
+# Alter Language: [name]
+#    Defines a new language or alters an existing one.  Its name can use any
+#    characters.  If any of the properties below have an add/replace form, you
+#    must use that when using Alter Language.
+#
+#    The language Shebang Script is special.  It's entry is only used for
+#    extensions, and files with those extensions have their shebang (#!) lines
+#    read to determine the real language of the file.  Extensionless files are
+#    always treated this way.
+#
+#    The language Text File is also special.  It's treated as one big comment
+#    so you can put Natural Docs content in them without special symbols.
+#
+# Extensions: [extension] [extension] ...
+# [Add/Replace] Extensions: [extension] [extension] ...
+#    Defines the file extensions of the language's source files.
+#
+# Shebang Strings: [string] [string] ...
+# [Add/Replace] Shebang Strings: [string] [string] ...
+#    Defines a list of strings that can appear in the shebang (#!) line to
+#    designate that it's part of the language.
+#
+# Simple Identifier: [name]
+#    The name of the language using only the letters A to Z.  No spaces,
+#    numbers, symbols, or Unicode allowed.  Defaults to the language name
+#    minus any unacceptable characters.  This is used to generate things like
+#    CSS class names.
+#
+# Aliases: [alias] [alias] ...
+# [Add/Replace] Aliases: [alias] [alias] ...
+#    Defines alternative names for the language that can be used to start a
+#    code block.
+#
+#
+# Properties for Basic Language Support Only
+# ------------------------------------------------------------------------
+# If you're adding your own language to Natural Docs you must define these.
+#
+# Line Comments: [symbol] [symbol] ...
+#    Defines a space-separated list of symbols that are used for line comments,
+#    if any.
+#
+# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
+#    Defines a space-separated list of symbol pairs that are used for block
+#    comments, if any.
+#
+# Member Operator: [symbol]
+#    Defines the default member operator symbol.  The default is a dot.
+#
+# Line Extender: [symbol]
+#    Defines the symbol that allows a prototype to span multiple lines if
+#    normally a line break would end it.
+#
+# Enum Values: [global|under type|under parent]
+#    Defines how enum values are referenced.  The default is global.
+#    global       - Values are always global, referenced as 'value'.
+#    under type   - Values are under the enum type, referenced as
+#                   'class.enum.value'.
+#    under parent - Values are under the enum's parent, referenced as
+#                   'class.value'.
+#
+# Case Sensitive: [yes|no]
+#    Defines whether the language's identifiers are case sensitive.  The
+#    default is yes.
+#
+# Block Comments Nest: [yes|no]
+#    Defines whether the language's block comments can nest.  The default is
+#    no.
+#
+# [Comment Type] Prototype Enders: [symbol] [symbol] ...
+#    When defined, Natural Docs will attempt to get a prototype from the code
+#    immediately following the comment type.  It stops when it reaches one of
+#    these symbols.  Use \n for line breaks.