Comments (5)
Hey @westurner, sorry for the late reply. Could you give me a quick explanation of what the use case here is? Do you have an example of a full repo where someone utilizes the RTD containers for their documentation builds?
From my other project: https://pycraft.readthedocs.io/en/latest/, most of the setup is done so that it just looks like a plain-old sphinx project https://github.com/ammaraskar/pyCraft/tree/master/docs and then RTD handles the building portion.
Is this so you can build the documentation with different versions of Python or automatically handle installing LaTeX etc?
from sphinx-action.
from sphinx-action.
Sphinx team also provides a docker image with latex. It’s smaller than the RTD one, but just enough for most use cases. I’d like to see the action allowing customization of Image used. Not sure if it’s doable. Might be easier to just fork and change the image name.
from sphinx-action.
To build MyST Markdown (with docutils and Sphinx roles and directives), jupyter-book has these
https://github.com/executablebooks/jupyter-book/blob/947b30f077dae7e39e34861360850dde3db67745/setup.py#L65 install_requires
edit: and also docs/requirements.txt
::
install_requires=[
"pyyaml",
"docutils>=0.15",
"sphinx>=2,<4",
"linkify-it-py~=1.0.1",
"myst-nb~=0.11.1",
"jupytext~=1.8.0",
"click",
"setuptools",
"nbformat",
"nbconvert<6",
"jsonschema",
"sphinx_togglebutton",
"sphinx-copybutton",
"sphinx-comments",
"sphinxcontrib-bibtex~=2.1.0",
"sphinx_book_theme>=0.0.39",
"sphinx-thebe>=0.0.6",
"sphinx-panels~=0.5.2",
"nested-lookup~=0.2.21",
],
- https://github.com/docker-library/python/blob/master/Dockerfile-slim.template (debian)
- https://github.com/sphinx-doc/docker/blob/master/base/Dockerfile
- https://github.com/sphinx-doc/docker/blob/master/latexpdf/Dockerfile
RUN python3 -m pip install jupyter-book gh-pages
- https://github.com/sphinx-doc/docker/blob/master/latexpdf/Dockerfile
- https://github.com/sphinx-doc/docker/blob/master/base/Dockerfile
from sphinx-action.
Have you seen anything for hosting multiple versions of docs with just GitHub Pages?
Could set the BUILDDIR to /docs/_build/html/./en/{revtag}/
and then add the /index.html
and /en/latest/index.html
pages with a templated HTML meta and/or JS redirect to the configured latest revtag URL: /en/v1.0.5/
from sphinx-action.
Related Issues (20)
- Build fails with Sphinx 4.1.0 HOT 5
- Build command make latexpdf (latexmk: Command not found)
- Cannot run apt update HOT 4
- Add support for -W option. HOT 1
- Add `output` in action.yml for number of warning
- set a specific python version HOT 3
- Does not work with yasfb
- Not all warnings by sphinx are forwarded as annotations
- Switch to 'sphinxdoc/sphinx-latexpdf', or offer as an alternative?
- Error: 'libtk8.6.so: cannot open shared object file: No such file or directory' when building documentation from files which contain tkinter HOT 1
- Does not work with python3.10 HOT 4
- none
- Problems with the Sphinx Workflow HOT 1
- ImportError: cannot import name 'environmentfilter' from 'jinja2'
- problem with `git describe --tags --abbrev=0` HOT 2
- Make the action compatible with sphinx-multiversion
- Problem reading logfile causes fatal error HOT 5
- make latexpdf failes
- Potential move to @sphinx-doc HOT 2
- Move master off of 2.4.4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx-action.