8000 Update Stackless additions to Doc/conf.py · Issue #259 · stackless-dev/stackless · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Feb 13, 2025. It is now read-only.

Update Stackless additions to Doc/conf.py #259

Closed
akruis opened this issue Jun 5, 2021 · 1 comment
Closed

Update Stackless additions to Doc/conf.py #259

akruis opened this issue Jun 5, 2021 · 1 comment
Assignees
@akruis
Labels
3.8-slp main-slp stackless python task

Comments

@akruis
Copy link
akruis commented Jun 5, 2021

Are theses lines still required and up to date?

stackless/Doc/conf.py

Lines 19 to 33 in a599283

# Compatibility hack for Sphinx version 1.2 and later
# without the 'sphinx.ext.refcounting' extension
# Required for http://stackless.readthedocs.org
try:
# this symbol is available starting from version 1.2
from sphinx import version_info
except Exception:
pass # version is pre 1.2.
else:
del version_info
del extensions[0]
if os.environ.get('READTHEDOCS', None) == 'True':
# Use the Sphinx default theme, not the very neat theme of readthedocs.org
# See https://docs.readthedocs.org/en/latest/faq.html#i-want-to-use-the-blue-default-sphinx-theme
html_style = '/default.css'

Remove or update them.
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py and .readthedocs.yml
b87f882 
Update the Stackless patches for readthedocs.org based on the
documentation. This simplified configuration is still untested.
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py and .readthedocs.yml
a15ae9c 
Well, the previous commit didn't build on readthedocs.org.
- Rename .readthedocs.yml to .readthedocs.yaml
  See https://docs.readthedocs.io/en/stable/config-file/index.html
- Add a requirements file Doc/slp_readthedocs_requirements.txt and
  require the same packages as specified in Makefile. Already set the
  Sphinx version to 2.0.1, because upstream commit 7d23dbe
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py
53ca885 
Set the css-file to "pydoctheme.css".
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py and .readthedocs.yml
73ac13c 
Update the Stackless patches for readthedocs.org based on the
documentation. This simplified configuration is still untested.

(cherry picked from commit b87f882)
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py and .readthedocs.yml
fe884c5 
Well, the previous commit didn't build on readthedocs.org.
- Rename .readthedocs.yml to .readthedocs.yaml
  See https://docs.readthedocs.io/en/stable/config-file/index.html
- Add a requirements file Doc/slp_readthedocs_requirements.txt and
  require the same packages as specified in Makefile. Already set the
  Sphinx version to 2.0.1, because upstream commit 7d23dbe

(cherry picked from commit a15ae9c)
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py
b101773 
Set the css-file to "pydoctheme.css".

(cherry picked from commit 53ca885)
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py
e61be11 
Remove the explicit specification of the css-file for readthedocs.org.
It is not needed any more.
@akruis akruis self-assigned this Aug 8, 2021
@akruis akruis added the main-slp label Aug 8, 2021
@akruis
Copy link
Author
akruis commented Aug 8, 2021

Readthedocs is always a moving target, but now (commit 53ca885) the documentation for branch 3.8-slp builds correctly. See https://stackless.readthedocs.io/en/3.8-slp/stackless-python.html.

Building the Stackless documentation on readthedocs.org now involves 2 files only:

  1. .readthedocs.yaml: overall specifications, refer to Doc/slp_readthedocs_requirements.txt
  2. Doc/slp_readthedocs_requirements.txt: defines the virtual env used to run Sphinx. Must match the
    requirements in target venv of Doc/Makefile

These changes are now in branch main-slp and 3.8-slp.

@akruis akruis closed this as completed Aug 8, 2021
akruis pushed a commit that referenced this issue Aug 8, 2021
Stackless issue #259: Update Doc/conf.py
ab63077 
Remove the explicit specification of the css-file for readthedocs.org.
It is not needed any more.

(cherry picked from commit e61be11)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@akruis akruis

Labels
3.8-slp main-slp stackless python task
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@akruis
0