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

Cleanup PDF output #36674

Merged
merged 7 commits into from Jul 15, 2021
Merged

Cleanup PDF output #36674

merged 7 commits into from Jul 15, 2021

Conversation

nashif
Copy link
Member

@nashif nashif commented Jul 1, 2021

  • doc: cleanup for PDF
  • doc: move kconfig to indices and table
  • doc: print tilte of Kconfig on top

Also fixes #6777

@nashif nashif requested a review from carlescufi as a code owner July 1, 2021 18:40
@nashif nashif requested a review from gmarull July 1, 2021 18:40
@nashif nashif force-pushed the pdf_output branch 3 times, most recently from 5af760b to d1f05ca Compare July 1, 2021 21:37
doc/index.rst Outdated Show resolved Hide resolved
doc/_scripts/gen_kconfig_rest.py Outdated Show resolved Hide resolved
Cleanup docs for PDFs hiding text that is relevant only for online docs.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Right now the kconfig index is randomly placed in the guides. This is a
table similar to other indeces we have and should be considered as part
of an appendix rather than place it in the middle of the documentation.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Add the symbol name on top and in the page title. This will enhance
search results and adds a missing page header that is needed.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Otherwise we end up with a self-reference to the same page we are in.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Point to the new branch to get the correct status.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Most of the content in the default index is HTML only, so create an
index just for PDF and keep it clean.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Add a link to best practices about copyright notices and when to and
when not to change them or add them.

Fixes zephyrproject-rtos#6777

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Copy link
Member

@cfriedt cfriedt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cfriedt cfriedt merged commit c995b11 into zephyrproject-rtos:main Jul 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add copyright handling to contributing doc
4 participants