Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First idea #1

Open
susuhahnml opened this issue Dec 5, 2024 · 0 comments
Open

First idea #1

susuhahnml opened this issue Dec 5, 2024 · 0 comments
Labels
question Further information is requested

Comments

@susuhahnml
Copy link
Collaborator

How the documentation for this page could be automatically generated

```
::: encodings/base.lp
    :root-file: false
    :source: true
    :predicate-table: true
    :dependency-graph: true
    :glosary: true
    :subfiles: true
    :glossary-references: true

```

- **root-file:** If the root file name is included, in this case it is not

- **source:** Shows the content of the source file (like mkdocstring)
    - The example of the source I only left in the first file, the rest don't have it, in favor of the github link

- **predicate-table:** Adds a table with the summary of all preicates
    - The summary table could be generated with chatgpt
- **dependency-graph:** Adds a dependency graph using mermaid. Dependency graph can be automatically computed perhaps with more detailed arrows
- **glossary:** Adds a section with the glossary of all predicates used
    - Perhaps the definition of atoms could be taken from clorm instead (if there is one)
- **glossary-references:** Adds a reference sections in each predicate of the glossary
    - Perhaps we also want to include references from instances as examples...
- **subfiles:** Includes all of the included files
@susuhahnml susuhahnml added the question Further information is requested label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant