flatdata icon indicating copy to clipboard operation
flatdata copied to clipboard

Publish on ReadTheDocs.org

Open deeplook opened this issue 5 years ago • 9 comments

Because now there is https://readthedocs.org/profiles/heremaps.

deeplook avatar Aug 15 '20 08:08 deeplook

Which component's docs would you like to publish there?

VeaaC avatar Aug 17 '20 05:08 VeaaC

Closed due to inactivity

VeaaC avatar Nov 10 '20 07:11 VeaaC

Which component's docs would you like to publish there?

Not sure I understand the question. All?

deeplook avatar Nov 10 '20 07:11 deeplook

flatdata is many components:

  • Schema language
  • Code generator
  • Python inspector
  • C++/Rust/Go backend

Many of those do not look like they should belong on ReadTheDocs (e.g. Rust has docs.rs)

VeaaC avatar Nov 10 '20 07:11 VeaaC

ReadTheDocs is language-agnostic and will happily provide HTML and PDF created from Markdown and ReST, if not more.

deeplook avatar Nov 10 '20 08:11 deeplook

But which languages is it actually used for?

VeaaC avatar Nov 10 '20 08:11 VeaaC

Pretty much anything you can think of? Try https://readthedocs.org/search/?q=X with X of your choice...

deeplook avatar Nov 10 '20 08:11 deeplook

I did that and could e.g. not find any Rust projects, and almost no C++ projects.

VeaaC avatar Nov 10 '20 08:11 VeaaC

Fine if you don't like it, but there is no language limitation. Do you have anything better to suggest in terms of functionality? See https://docs.readthedocs.io.

deeplook avatar Nov 10 '20 11:11 deeplook