Always build docs with latest theme

[Blendify]

No description provided.

[davidfischer]

I would think that the docs for this theme should be built with the version of theme the docs are for. Let's say we ever have to maintain two concurrent versions (say for Sphinx < 2.0 and Sphinx >= 2.0), we wouldn't want them both to build with the latest master of the theme. Does that make sense?

[Blendify]

So we should release the theme each time sphinx releases a version?

…

On Mon, Jan 15, 2018 at 5:21 PM, David Fischer ***@***.***> wrote: I would think that the docs for this theme should be built with the version of theme the docs are for. Let's say we ever have to maintain two concurrent versions (say for Sphinx < 2.0 and Sphinx >= 2.0), we wouldn't want them both to build with the latest master of the theme. Does that make sense? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#541 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOeua2DJ2JDnwDfsFbD29QOASu1lyseSks5tK89ggaJpZM4Rdu_N> .

-- Aaron Carlisle Picture taker | Bit cruncher | Pixel pusher | Document writer | Project administrator for the Blender 3D Documentation Project

[davidfischer]

I don't think I understand what you're suggesting.

Doesn't this line already handle what you're proposing with this PR?

[Blendify]

It would be html_theme_path but I think something is overriding it

…

On Jan 15, 2018 6:40 PM, "David Fischer" ***@***.***> wrote: I don't think I understand what you're suggesting. Doesn't this line <https://github.com/rtfd/sphinx_rtd_theme/blob/d332646/docs/conf.py#L18> already handle what you're proposing with this PR? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#541 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOeua9hwvkIdhQ7ot2YRdHb4k9p5Vk1hks5tK-HxgaJpZM4Rdu_N> .

[jessetan]

This already works for me as I would expect on master. The documentation in docs uses the theme as built one directory up.
Is this different from what you are expecting to happen @Blendify ?

[Blendify]

The issue is I don't think it is working on Read The Docs

…

On Jan 23, 2018 5:38 AM, "Jesse Tan" ***@***.***> wrote: This already works for me as I would expect on master. The documentation in docs uses the theme as built one directory up. Is this different from what you are expecting to happen @Blendify <https://github.com/blendify> ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#541 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOeua1A2RemvhtOihW4JlD6kLENvxTKbks5tNbangaJpZM4Rdu_N> .

[jessetan]

I think it doesn't work on RTD because it checks out the source in a folder named for the branch it's building (e.g. .../user_builds/sphinx-rtfd-theme/checkouts/some-branch), rather than sphinx_rtd_theme. The theme can then not be found by name and the default version installed by RTD will be used.

Rather than add master, you can add -e . to requirements.txt. If the requirements are installed from the point of checkout (sphinx_rtd_theme) using pip install -r docs/requirements.txt, it will install the theme located at sphinx_rtd_theme.
This does not work if the pip install is done from within the docs directory, because oddly the path is resolved from where pip install was called, not from the location of requirements.txt (see pypa/pip#3772)

[Blendify]

Still can't get this to work and its more than just the test. Here is the error:

C:\Users\Aaron\Documents\Projects\Read the Docs\sphinx_rtd_theme>pip install -r requirements.txt --upgrade
Obtaining file:///C:/Users/Aaron/Documents/Projects/Read%20the%20Docs/sphinx_rtd_theme (from -r requirements.txt (line 3))
    Complete output from command python setup.py egg_info:

    ----------------------------------------
Command "python setup.py egg_info" failed with error code 1 in C:\Users\Aaron\Documents\Projects\Read the Docs\sphinx_rtd_theme\

[jessetan]

What is your output if you run python setup.py egg_info yourself?

I get:

running egg_info
writing sphinx_rtd_theme.egg-info/PKG-INFO
writing top-level names to sphinx_rtd_theme.egg-info/top_level.txt
writing dependency_links to sphinx_rtd_theme.egg-info/dependency_links.txt
writing entry points to sphinx_rtd_theme.egg-info/entry_points.txt
reading manifest file 'sphinx_rtd_theme.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'sphinx_rtd_theme.egg-info/SOURCES.txt'

[Blendify]

Yes I get that too.

…

On Wed, Feb 14, 2018 at 4:05 AM, Jesse Tan ***@***.***> wrote: What is your output if you run python setup.py egg_info yourself? I get: running egg_info writing sphinx_rtd_theme.egg-info/PKG-INFO writing top-level names to sphinx_rtd_theme.egg-info/top_level.txt writing dependency_links to sphinx_rtd_theme.egg-info/dependency_links.txt writing entry points to sphinx_rtd_theme.egg-info/entry_points.txt reading manifest file 'sphinx_rtd_theme.egg-info/SOURCES.txt' reading manifest template 'MANIFEST.in' writing manifest file 'sphinx_rtd_theme.egg-info/SOURCES.txt' — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#541 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOeua4uG-H7Qo86VRM9QoQMnpAWnX1qXks5tUqHJgaJpZM4Rdu_N> .

-- Aaron Carlisle Picture taker | Bit cruncher | Pixel pusher | Document writer | Project administrator for the Blender 3D Documentation Project

[jessetan]

Have you tried updating pip or setuptools first? Might be a permissions thing otherwise (don't know exactly how that would work on Windows), using a virtualenv should help

[Blendify]

Yeah, I will try that later.

…

On Wed, Feb 14, 2018 at 8:52 AM, Jesse Tan ***@***.***> wrote: Have you tried updating pip or setuptools first? Might be a permissions thing otherwise (don't know exactly how that would work on Windows), using a virtualenv should help — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#541 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOeua9xdY6TiROrpAIe6k2bsvPHPYzsnks5tUuUdgaJpZM4Rdu_N> .

-- Aaron Carlisle Picture taker | Bit cruncher | Pixel pusher | Document writer | Project administrator for the Blender 3D Documentation Project

[agjohnson]

Installing the package during RTD build is the correct method. You can also get rid of the requirements.txt entirely and just install the dependencies through standard setup.py/setup.cfg mechanics. RTD has an option to install the package as a build step.

[agjohnson]

This is closer to the correct approach. I'd also be +1 on removing the need for requirements.txt -- I don't like using this file on packages. Not a strong requirement here from me though.

[Blendify]

Is there a way to stop RTD from using an installed version of the theme?