semvec/pypi-packages huggingface dataset:
madoc 1.2.6
Documentation generator from markdown files
Requires Python: >=3.8
Keywords: markdown, html, documentation

# Madoc


## What is Madoc for ?

It is a terminal tool to automatically generate a single html documentation file from all
the .md files found in the directory.

Cool stuff to join a clean and easy to read documentation to some project.


# Installation

```console
pip install madoc
```


# Usage

Open a terminal in the directory where the .md files are,
and just type:

`madoc`

done, you have your documentation in a single html file.

Know more options with `madoc -h`.


# Changelog

- 1.2.6: converts download links to base64 (optionnal)
- 1.2.5: responsive design improved, possibility to prefix the files with '(XXX..)' to sort the files without appearing in the displayed names
- 1.2.0: reworked without any JS dependencies (=readable offline), prettier template, base64 images conversion !
    - to be deprecated: the recursive option, will be replaced by something else (WIP...)
- 1.1.1: responsive design
- 1.1.0: Recursive build mode

# Libraries used by Madoc
JS  (used in recursive mode only)
- Bulma (CSS framework)
- Vue.js (JS framework)
- Marked (JS library)

Python (already included in the pip setup)
- Jinja2 (python library)
- markdown
- Pygments
- requests
grammateus 0.1.3
A role responsible for documenting legal proceedings in Greece
Requires Python: >=3.10
Keywords: grammateus, recording, ai

# Grammateus 
<pre>
    In ancient Greece the specific role responsible for documenting
    legal proceedings, similar to a scribe or notary, was called a 
    "grammateus" (γραμματεύς).
</pre>
Documenting interactions with Language Models requires several types of records, namely: a 'technical log' - the exact queries presented to the Model through the API and API responses; a 'conversation history' - the formatted messages and responses that can be re-sent back to the model (a local 'cache'); and, finally, a human-readable 'record of conversation' which can be easily ingested back into the Python code querying the Model and transformed for continuation of the conversation.

The first and second tasks are easily solvable with `jsonlines` library and `jl` format. It took me some time to realize that the best format for human-readable record is `YAML`.

There are two main reasons for that: YAML lets you drop double quotes, and YAML (unlike JSON)permits comments which are absolutely necessary if you are systematically working on natural language interactions with Language Models.

In particular, a human-readable record of conversation can look like this:
```yaml
- instruction: Be an Abstract Intellect.      # this is a comment
- Human: Let's talk about Human Nature.       # this is a comment
- machine: Yes, let's do that, it's a complex topic...
```