Some clean up in docbuilding #19127

jdemeyer · 2015-09-03T15:40:54Z

No change in functionality, just some clean up.

In particular:

move the code for running Sphinx to src/sage_setup/docbuild
do not create and delete empty directories, instead silence the Sphinx warnings about non-existing directories
instead of compile(), use import
add a new variable SAGE_DOC_OUTPUT for src/doc/output (this is moved to local/share/doc/sage in Build documentation in $SAGE_SHARE/doc/sage #19963)

Depends on #19950

CC: @hivert @nathanncohen

Component: build

Author: Jeroen Demeyer

Branch: 0455d14

Reviewer: Marc Mezzarobba

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

The text was updated successfully, but these errors were encountered:

jdemeyer · 2015-09-03T15:58:24Z

Branch: u/jdemeyer/ticket/19127

jdemeyer · 2015-09-03T15:58:53Z

Commit: 2e2cb7a

jdemeyer · 2015-09-03T15:58:53Z

New commits:

`2e2cb7a`	`Docbuilder cleanup`

sagetrac-git · 2015-09-03T19:48:35Z

Changed commit from 2e2cb7a to d959af4

sagetrac-git · 2015-09-03T19:48:35Z

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

`d959af4`	`builder/__init__.py should not be executable`

sagetrac-git · 2015-09-08T20:38:49Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`ff58c9c`	`Replace conf.py copies by symlinks`
`d783ee1`	`Docbuilder cleanup`

sagetrac-git · 2015-09-08T20:38:49Z

Changed commit from d959af4 to d783ee1

jdemeyer · 2015-09-08T20:39:09Z

Dependencies: #19166

sagetrac-git · 2015-11-07T11:47:36Z

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

`9b12694`	`Merge tag '6.10.beta3' into t/19127/ticket/19127`

sagetrac-git · 2015-11-07T11:47:36Z

Changed commit from d783ee1 to 9b12694

sagetrac-git · 2016-01-10T21:51:55Z

Changed commit from 9b12694 to 97a6f82

sagetrac-git · 2016-01-10T21:51:55Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`97a6f82`	`Merge tag '7.0.beta3' into t/19127/ticket/19127`

jdemeyer · 2016-01-10T21:52:31Z

Changed dependencies from #19166 to none

sagetrac-git · 2016-01-24T10:36:35Z

Changed commit from 97a6f82 to ea7efaa

sagetrac-git · 2016-01-24T10:36:35Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`ea7efaa`	`Docbuilder cleanup`

sagetrac-git · 2016-01-25T10:29:44Z

Changed commit from ea7efaa to f0f0e4c

sagetrac-git · 2016-01-25T10:29:44Z

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

`f0f0e4c`	Use `__main__` to run docbuilder

sagetrac-git · 2016-01-25T14:07:38Z

Changed commit from f0f0e4c to 2fbfe8e

sagetrac-git · 2016-01-25T14:07:38Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`2fbfe8e`	`Docbuilder cleanup`

sagetrac-git · 2016-01-25T17:10:12Z

Changed commit from 2fbfe8e to 93339c2

sagetrac-git · 2016-01-25T17:10:12Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`93339c2`	`Docbuilder cleanup`

sagetrac-git · 2016-01-25T21:06:04Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`67b8e35`	`Docbuilder cleanup`

sagetrac-git · 2016-01-25T21:06:04Z

Changed commit from 93339c2 to 67b8e35

sagetrac-git · 2016-01-26T07:29:55Z

Changed commit from 67b8e35 to 7c98158

vbraun · 2016-01-28T17:13:58Z

comment:23

http://build.sagedev.org/release/builders/%20%20fast%20Volker%20Desktop%20%28Fedora%2022%20x86_64%29%20incremental/builds/366/steps/shell_4/logs/stdio

jdemeyer · 2016-01-28T18:22:35Z

comment:24

That failure looks unrelated to the documentation, so I would be surprised if that buildbot error was due to this ticket. Which other tickets did you test?

jhpalmieri · 2016-01-28T18:36:32Z

comment:25

Unrelated to the doctest failure: should the clean target in src/doc/Makefile also do something like rm -f common/*.pyc? It would be good to clean up common/builder.pyc and other left-over files.

jdemeyer · 2016-01-28T19:04:14Z

comment:26

Replying to @vbraun:

http://build.sagedev.org/release/builders/%20%20fast%20Volker%20Desktop%20%28Fedora%2022%20x86_64%29%20incremental/builds/366/steps/shell_4/logs/stdio

Confirmed (but still surprising!)

jdemeyer · 2016-01-28T19:15:05Z

comment:27

The problem seems to be that doctesting the old src/doc/output files fails because they are no longer consider "Sage library" files. Easily fixed by removing src/doc/output.

sagetrac-git · 2016-01-28T19:36:36Z

Changed commit from 537d9d2 to 2b37da3

sagetrac-git · 2016-01-28T19:36:36Z

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

`2b37da3`	`Remove old src/doc/ouput and .pyc files`

jdemeyer · 2016-01-28T22:47:49Z

comment:29

Oops, I was confusing this ticket with #19963. Never mind this last commit.

sagetrac-git · 2016-01-28T22:50:08Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

sagetrac-git · 2016-01-28T22:50:08Z

Changed commit from 2b37da3 to 537d9d2

sagetrac-git · 2016-01-29T06:57:36Z

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

`2f8fe6b`	`Use force_lib=True for "doc" modules`

sagetrac-git · 2016-01-29T06:57:36Z

Changed commit from 537d9d2 to 2f8fe6b

jdemeyer · 2016-01-29T07:06:51Z

comment:33

I will merge #19950 because these tickets conflict.

jdemeyer · 2016-01-29T07:06:51Z

Dependencies: #19950

sagetrac-git · 2016-01-29T07:09:07Z

Changed commit from 2f8fe6b to 0455d14

sagetrac-git · 2016-01-29T07:09:07Z

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

`b5e3668`	`allow the docbuild of a single file to build also underscore methods`
`5352485`	`Merge branch 'public/19950' into 7.1.b0`
`0455d14`	`Merge remote-tracking branch 'trac/public/19950' into t/19127/ticket/19127`

vbraun · 2016-02-02T23:06:38Z

Changed branch from u/jdemeyer/ticket/19127 to 0455d14

jm58660 · 2016-03-30T07:32:11Z

Changed commit from 0455d14 to none

jm58660 · 2016-03-30T07:32:11Z

comment:37

Is this the reason for #20255?

jdemeyer added this to the sage-6.9 milestone Sep 3, 2015

jdemeyer added c: build labels Sep 3, 2015

jdemeyer added the s: needs review label Sep 3, 2015

This comment has been minimized.

Sign in to view

vbraun added s: needs work and removed s: positive review labels Jan 28, 2016

jdemeyer added s: needs review and removed s: needs work labels Jan 29, 2016

mezzarobba added s: positive review and removed s: needs review labels Feb 2, 2016

vbraun removed the s: positive review label Feb 2, 2016

vbraun closed this as completed in 9e52b0b Feb 2, 2016

This was referenced Feb 12, 2016

Build documentation in $SAGE_SHARE/doc/sage #19963

Closed

Delete empty directories in $SAGE_DOC #20010

Closed

mkoeppe mentioned this issue Mar 9, 2021

Split sage_setup.docbuild out to a separate distribution sage_docbuild #30010

Closed

Some clean up in docbuilding #19127

Some clean up in docbuilding #19127

Comments

jdemeyer commented Sep 3, 2015

jdemeyer commented Sep 3, 2015

jdemeyer commented Sep 3, 2015

jdemeyer commented Sep 3, 2015

sagetrac-git mannequin commented Sep 3, 2015

sagetrac-git mannequin commented Sep 3, 2015

sagetrac-git mannequin commented Sep 8, 2015

sagetrac-git mannequin commented Sep 8, 2015

jdemeyer commented Sep 8, 2015

sagetrac-git mannequin commented Nov 7, 2015

sagetrac-git mannequin commented Nov 7, 2015

sagetrac-git mannequin commented Jan 10, 2016

sagetrac-git mannequin commented Jan 10, 2016

jdemeyer commented Jan 10, 2016

sagetrac-git mannequin commented Jan 24, 2016

sagetrac-git mannequin commented Jan 24, 2016

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 25, 2016

This comment has been minimized.

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 25, 2016

sagetrac-git mannequin commented Jan 26, 2016

vbraun commented Jan 28, 2016

jdemeyer commented Jan 28, 2016

jhpalmieri commented Jan 28, 2016

jdemeyer commented Jan 28, 2016

jdemeyer commented Jan 28, 2016

sagetrac-git mannequin commented Jan 28, 2016

sagetrac-git mannequin commented Jan 28, 2016

jdemeyer commented Jan 28, 2016

sagetrac-git mannequin commented Jan 28, 2016

sagetrac-git mannequin commented Jan 28, 2016

sagetrac-git mannequin commented Jan 29, 2016

sagetrac-git mannequin commented Jan 29, 2016

jdemeyer commented Jan 29, 2016

jdemeyer commented Jan 29, 2016

sagetrac-git mannequin commented Jan 29, 2016

sagetrac-git mannequin commented Jan 29, 2016

vbraun commented Feb 2, 2016

jm58660 mannequin commented Mar 30, 2016

jm58660 mannequin commented Mar 30, 2016