Add ability to build and map alternate documentation formats #70
Comments
Add documentation detailing appropriate configuration of the smv_build_targets configuration setting including exemplars to illustrate the features and also limitations of this feature. Add documentation detailing appropriate configuration of the smv_clean_intermediate_files configuration setting. Add exemplar usage of the new artefacts object in the html context within template files. Closes Holzhaus#70.
Add documentation detailing appropriate configuration of the smv_build_targets configuration setting including exemplars to illustrate the features and also limitations of this feature. Add documentation detailing appropriate configuration of the smv_clean_intermediate_files configuration setting. Add exemplar usage of the new artefacts object in the html context within template files. Closes Holzhaus#70.
|
I implemented that for https://manual.mixxx.org over at @mixxxdj/manual by using the HTML context variables to construct a path. |
|
Hi @Holzhaus , I'm not sure that's exactly the same thing. That requires you to independently and externally generate the pdf documentation. What I've implemented in PR #74 will use sphinx builders to generate the pdf version of the documentation at the same time as the html documentation for each version and make a link to that artefact available in the build context. The "for each version" part of documentation generation is the hard part when it comes to creating artefacts, without essentially recreating everything that sphinx-multiversion already does - so I think that it has a place within the scope of sphinx-multiversion. Unless you're integrating your pdf build with sphinx-multiversion in a way that I can't see? |
|
@Holzhaus can you elaborate on how you're building the pdf documentation? |
Sphinx is capable of building documentation in a range of different formats detailed by
sphinx.builders. It would be good to be able to support building and indexing all of these such that they are linkable via the widget. It's a feature that I really like about what readthedocs does. I'm personally only really interested in pdf, but here's a list of formats that might be useful:Example of what I would like to be able to do with respect to the "Downloads" section:
If you can provide some advice on how this might be best implemented I might be able to allocate some time to implementing this.
The text was updated successfully, but these errors were encountered: