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

Feature request: rewrite index.html files in README.md format #4

Closed
anton-malakhov opened this issue Oct 20, 2016 · 3 comments
Closed

Comments

@anton-malakhov
Copy link

anton-malakhov commented Oct 20, 2016

GitHub does not show index.html as directory description and reading index.html files is hard in plain text.
Markdown (.md) syntax is clean for direct reading (and maintaining!) and also converts easily to .html preserving all the formatting features.

E.g. online converter is here: https://pandoc.org/try/?text=&from=html&to=markdown_github

@tbbdev
Copy link
Contributor

tbbdev commented Nov 28, 2016

It will be hard to support two versions of documentation. We need to think how to make it optimal.

@svenevs
Copy link

svenevs commented Jan 4, 2018

How is the documentation generated? It looks like doxygen is used (some @ingroup going on), but I couldn't actually find any of the tools in this repo to generate the docs. FWIW, you can just add the markdown files to INPUT with doxygen.

@aleksei-fedotov
Copy link
Contributor

It seems GitHub can render .rst file format as well. oneTBB is moving in this direction. So, this will be automatically covered. Therefore, I think the issue can be closed. Interested people could reopen it if they deem useful.

@tbbdev tbbdev closed this as completed Mar 24, 2020
pavelkumbrasev added a commit that referenced this issue Jan 28, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Feb 4, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Feb 24, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Nov 28, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Dec 2, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Dec 2, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Dec 6, 2022
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Jan 16, 2023
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Jan 31, 2023
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Mar 21, 2023
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Apr 3, 2023
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue Apr 17, 2023
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
pavelkumbrasev added a commit that referenced this issue May 5, 2023
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants