AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

documentation: add a full table of content for API pages

オープン
#2,009 コメント 6 件 リアクション 1 件 担当者 1 名 @czerouni が担当を希望しています GitHub で見る
Documentation good first issue help wanted
主要言語
C++
スター
2.1k
フォーク
503
PR マージ指標
30日以内にマージされた PR はありません

説明

Hello,

This a improvement request for the OpenColorIO documentation.

# issue

When browsing the API documentation, example https://opencolorio.readthedocs.io/en/latest/api/config.html it is very hard to find the object you are looking for because of the lack of a table of contents providing a summarized overview of the whole page.
We can also notice that all the code objects are missing a permalink anchor to quickly share a direct link to them.

![recording of browsing the ocio doc](https://github.com/user-attachments/assets/9d811f52-e03c-4cf3-b753-7b11c3888870)

If we have a look at the pages like https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html we can see in the left side-bar that there is some table-of-content going on but it is shallow, i.e. only listing top-level headings and not lower-lever headings like h3.

![ocio documentation screenshot](https://github.com/user-attachments/assets/c02cb827-e90f-4e00-87c2-6ab46763c338)
> ^ screenshot of the doc showing that h2 are not being listed in the sidebar toc

# request

I would really love:

- adding a deep table-of-content (showing all headings level) in an easy to access area in the page (I personally love to that are pinned to the right of your screen and stay in position when you scroll)
- adding permalink for every code object that is being documented

---
Let me know if something is not clear.
Best,
Liam.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。