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

Weird looking "duplicate" menu for start file without toctree #64

Closed
sypets opened this issue Jun 11, 2019 · 6 comments

Comments

@sypets
Copy link
Contributor

commented Jun 11, 2019

Reproduce

Render documentation using single file documentation README.md (e.g. from "seeder" extension) with latest Docker 2.1.0 image:

git clone https://github.com/TildBJ/seeder
source <(docker run --rm t3docs/render-documentation:v2.1.0 show-shell-commands)
dockrun_t3rd makehtml
open Documentation-GENERATED-temp/Result/project/0.0.0/Index.html

Result

  • The main menu is in submenu "seeder"
  • additionally, the same menu is on top level, but dimmed

seeder

seeder2

Related

@marble marble self-assigned this Jun 11, 2019

@sypets sypets changed the title Weird looking "duplicate" menu for single-file solution (README.md) Weird looking "duplicate" menu for start file without toctree Jun 12, 2019

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Jun 12, 2019

I tested some more: AFAIK, this problem occurs if the start page of the documentation (doesn't matter what it is, it can be README.rst or Documentation/Index.rst):

  • does not contain a toctree
  • and header level 1 only has one entry

Examples where problem occurs:

  1. one file without toctree:
=====
Title
=====

Some stuff on start page

Topic 1
=======

sfsd sdfsf

Topic 2
=======

sdfsdf

Examples where problem does not occur:

  1. Start page with toctree
=====
Title
=====

.. toctree::

   Topic1
   Topic2

  1. Start page with header level 1 with more than 1 entry

This basically means we leave out the title header.

Topic 1
=======

sfsd sdfsf

Topic 2
=======

sdfsdf

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Jun 12, 2019

@marble It would be great, if we could get a timeframe for a solution. Because question is if we can solve this in the near future or we should propose a workaround (e.g. use example 3 above).

@marble

This comment has been minimized.

Copy link
Contributor

commented Jun 14, 2019

Fixed with Release v2.2.0 (June 14, 2019) = just now
Build t3docs/render-documentation:develop can already be pulled. Other builds are on the way. Looks like
image

@marble marble closed this Jun 14, 2019

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Jun 14, 2019

@marble I get errors with the "develop" version. I tested with timymce extension. This rendered ok with previous version (except for missing title because of missing Settings.cfg).

git clone https://gitlab.sgalinski.de/typo3/tinymce.git
cd tinymce
source <(docker run --rm t3docs/render-documentation:develop show-shell-commands)
dockrun_t3rd makehtml

@marble

This comment has been minimized.

Copy link
Contributor

commented Jun 14, 2019

Yes, thanks for reporting, stupid logic error. I've already published a bugfix version v2.2.1 = master = develop. Should be assembled by docker hub soon.

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Jun 24, 2019

There are still some issues with 2.2.6 + single files.

If you use a doc title and a single file with 2.2.6, you get problems.

Example 1: Documenation/Index.rst

menu

Example 2: README.rst

see:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.