integrating Sphinx with another platform?
30 views
Skip to first unread message
Bruce Hoppe
Dec 9, 2021, 5:29:41 PM12/9/21
to sphinx-users
Hello Sphinx Users!
I am new to Sphinx and excited about its capabilities. I am designing a complete site for an open-source code project, and documentation will be central. But our main site will do more more than documentation. It might look like https://numpy.org or https://julialang.org, for example, enticing people to install and participate etc.
I am struggling to understand how Sphinx integrates with another platform other than ReadtheDocs. For example, if we use Jekyll or WordPress as a central platform, how do people typically integrate Sphinx output with those environments?
Thank you for any suggestions or guiding questions.
Best regards,
Bruce Hoppe
OpenCilk.org
Matt Documatt
Dec 20, 2021, 3:38:03 PM12/20/21
to sphinx...@googlegroups.com
Hello Bruce and welcome to Sphinx!
For me, such "integration" actually means building HTML from Sphinx project and static files serving.
For example, / is your main WordPress/whatever-powered website, while /docs are static files generated from Sphinx. You mix two different types of website hosting behind the scenes. For Apache, it is possible with mod_alias. It allows for content that is not directly under the DocumentRoot served as part of the web document tree.
The easiest is if the main website and docs are on different domains (example.com and docs.example.com). The main website stays as is, docs are simple static hosting.
In both cases, you likely want the to docs to look like the main website. It means you need to create a Sphinx theme that looks like your main website.
-
Matt
https://techwriter.documatt.com
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/0b223614-378d-45e2-ab27-af7e86cc4ccan%40googlegroups.com.
For me, such "integration" actually means building HTML from Sphinx project and static files serving.
For example, / is your main WordPress/whatever-powered website, while /docs are static files generated from Sphinx. You mix two different types of website hosting behind the scenes. For Apache, it is possible with mod_alias. It allows for content that is not directly under the DocumentRoot served as part of the web document tree.
The easiest is if the main website and docs are on different domains (example.com and docs.example.com). The main website stays as is, docs are simple static hosting.
In both cases, you likely want the to docs to look like the main website. It means you need to create a Sphinx theme that looks like your main website.
-
Matt
https://techwriter.documatt.com
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/0b223614-378d-45e2-ab27-af7e86cc4ccan%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages