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.

Sign up for GitHub

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

Jump to bottom

The manual can't be used when built with Sphinx >= 5 #121

Closed
rptb1 opened this issue Jan 18, 2023 · 0 comments · Fixed by #166
Closed

The manual can't be used when built with Sphinx >= 5 #121

rptb1 opened this issue Jan 18, 2023 · 0 comments · Fixed by #166
Labels
documentation essential Will cause failure to meet customer requirements. Assign resources. maintainability Affects the cost of maintaining the MPS to meet current requirements.

Comments

@rptb1
Copy link
Member

rptb1 commented Jan 18, 2023 •
edited
Loading

When built with Sphinx 5 or 6, the manual layout looks like this
image
(Firefox 108.0.2):

The links in the main text are not clickable.

See #67 (comment) and #67 (comment).

Worked around in 54df366.

Related to #98 (comment) because it would be nice to be able to publish the manual on e.g. Read The Docs.
rptb1 added a commit that referenced this issue Jan 18, 2023
@rptb1
Specifying Sphinx version before 5 because the manual layout is curre…
54df366 
…ntly broken under Sphinx 5 and 6 <#121>.  Because that means we're using a variant of Sphinx, also making a venv-installed Sphinx the default.
@rptb1 rptb1 changed the title The layout of the manual is poor when built with Sphinx >= 5 The manual can't be used when built with Sphinx >= 5 Jan 18, 2023
@rptb1 rptb1 added optional Will cause failures / of benefit. Worth assigning resources. documentation labels Jan 18, 2023
@thejayps thejayps added essential Will cause failure to meet customer requirements. Assign resources. and removed optional Will cause failures / of benefit. Worth assigning resources. labels Feb 20, 2023
@rptb1 rptb1 mentioned this issue Feb 22, 2023
Merged
@rptb1 rptb1 added the maintainability Affects the cost of maintaining the MPS to meet current requirements. label Feb 23, 2023
@rptb1 rptb1 mentioned this issue Feb 27, 2023
Open
rptb1 added a commit that referenced this issue Feb 27, 2023
@rptb1
Switching to the Read the Docs theme fixes layout problems described …
96a1cb6 
…in GitHub issue #121 <#121>.
@rptb1 rptb1 linked a pull request Feb 27, 2023 that will close this issue
Switch the MPS manual to using the Read the Docs theme #166
Merged
@rptb1 rptb1 mentioned this issue Mar 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation essential Will cause failure to meet customer requirements. Assign resources. maintainability Affects the cost of maintaining the MPS to meet current requirements.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Switch the MPS manual to using the Read the Docs theme Ravenbrook/mps
2 participants
@rptb1 @thejayps