search

logux / django

Django Logux integration engine
https://logux.org/
MIT License
17 stars 3 forks source link

Add API docs to Logux website #23

Open ai opened 4 years ago

ai commented 4 years ago

We need an API doc like we have for Node.js.

I will like to have the same design for API docs across all languages. So we will need to write a custom HTML generator. It is hard, but I will do most of the work.

I need a help only to:

  1. Create a Make task to generate a JSON file of API.
  2. Give me a set of commands from git clone to get that JSON file of API.
egregors commented 4 years ago

@ai So, you wanna all Logux integration projects have smth like make docs witch generate one JSON file will full API description? Do we talk about auto-gen documentation? Where I can find the schema of JSON objects you will expect?

ai commented 4 years ago

So, you wanna all Logux integration projects have smth like make docs witch generate one JSON file will full API description?

Every project will generate own file with JSON (and they can use different schema). Then by JS converter, I will convert it to the same HTML.

Here is how I do it for TypeDoc (I use JS object instead of JSON in the case of TypeScript):

  1. Call TypeDoc built-in tool to get objects with API docs
  2. Convert these objects to HTML

Where I can find the schema of JSON objects you will expect?

I will write a convertor from any JSON schema.

Something like

egregors commented 4 years ago

rel https://github.com/logux/logux.io/pull/22

Make sure make docs works properly from the ENV