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

Alllow arbitrary folder as output directory of docbuild #31221

Closed
tobiasdiez opened this issue Jan 10, 2021 · 10 comments
Closed

Alllow arbitrary folder as output directory of docbuild #31221

tobiasdiez opened this issue Jan 10, 2021 · 10 comments

Comments

@tobiasdiez
Copy link
Contributor

It was not possible to specify an arbitrary folder as the output of the docbuild, because the citation extension had an assertion that checked that the output directory was a subfolder of SAGE_DOC. This check is replaced by providing some default folder for the citations in case the output directory is not below SAGE_DOC.

This is allows to build the documentation by running sphinx manually, which is required by some tools (e.g. the restructuredtext extension for VS code provides a HTML preview of the currently edited rst file by running sphinx on it).

I also used the opportunity to convert the code in question to use pathlib.

CC: @tscrim @nthiery @fchapoton @mkoeppe @jhpalmieri

Component: documentation

Author: Tobias Diez

Branch: ad75421

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/31221

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jan 10, 2021

Branch pushed to git repo; I updated commit sha1. New commits:

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jan 10, 2021

Commit: 9d686f2

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jan 10, 2021

Changed commit from 9d686f2 to ad75421

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jan 10, 2021

Branch pushed to git repo; I updated commit sha1. New commits:

ad75421Alllow arbitrary folder as output directory of docbuild

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Member

mkoeppe commented Jan 16, 2021

comment:5

Patchbot is green, looks fine to me.

@mkoeppe
Copy link
Member

mkoeppe commented Jan 16, 2021

Reviewer: Matthias Koeppe

@tobiasdiez
Copy link
Contributor Author

comment:6

Thanks!

@vbraun
Copy link
Member

vbraun commented Jan 24, 2021

Changed branch from public/documentation/allow-from-arbitrary-folder to ad75421

@fchapoton
Copy link
Contributor

Changed commit from ad75421 to none

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants