https://github.com/ramsailopal/sphinx
A Dockerized Sphinx environment for generating html and pdf from mark down files
https://github.com/ramsailopal/sphinx
docops html markdown pdf sphinx
Last synced: about 2 months ago
JSON representation
A Dockerized Sphinx environment for generating html and pdf from mark down files
- Host: GitHub
- URL: https://github.com/ramsailopal/sphinx
- Owner: RamSailopal
- Created: 2023-05-11T10:43:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-11T10:52:03.000Z (about 3 years ago)
- Last Synced: 2025-05-21T05:36:46.725Z (about 1 year ago)
- Topics: docops, html, markdown, pdf, sphinx
- Language: Python
- Homepage:
- Size: 318 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Containerised Sphinx Environment
A Docker container Sphinx environment for generating html/pdf from mark down files.
## Running the container
git clone https://github.com/RamSailopal/Sphinx
cd Sphinx
docker run --name Vista-Sphinx -d -v "$PWD/share:/home/sphinx" -p "3090:80" --entrypoint /home/sphinx/entrypoint.sh ubuntu
## Creating new Mark Down content
Add a new md file in the docs folder and then amend **index.rst**, adding the new file name (without the .md extension) under **.. toctree::** (Ensure a space exists)
## Building Changes
To build html, run
docker exec -it Vista-Sphinx /home/sphinx/build.sh html
Changes will then be viewable at http://locahost:3090
To build pdf:
docker exec -it Vista-Sphinx /home/sphinx/build.sh pdf
Monitor, the output as this will tell you the pdf file name generated i.e
*Latexmk: Log file says output to 'Test.pdf'
With the name of the pdf file, navigate to: http://localhost:3090/test.pdf to view the pdf document
To build both html and pdf:
docker exec -it Vista-Sphinx /home/sphinx/build.sh both
## References
https://cerodell.github.io/sphinx-quickstart-guide/build/html/quickstart.html