Jonathan Thomas
6e3ecf7983
Adding GA4 tracking instructions for user-guide documentation for openshot.org website
2026-01-25 18:04:51 -06:00
Jonathan Thomas
43ed835ff5
Adding instructions for generating all user-guide translations for the openshot website, and adding a toggle to make the html docs use relative parent paths for (_static, _images, _sources) for easier serving of the user-guide translations.
2026-01-24 19:06:28 -06:00
Jonathan Thomas
37c6191017
Fixed latex user-guide pdf output for most languages, including bn and ar - still RTL issues though, and a few languages still have issues: "ar" "hi" "ja" "ko"
2026-01-24 17:02:50 -06:00
Jonathan Thomas
1573365176
Initial POT english templates for user-guide for v3.4 of OpenShot, and initial French translation - for testing.
2026-01-22 18:11:21 -06:00
Jonathan Thomas
c5bc7c9ac0
Removing sphinx_markdown_builder pip dependency from our documentation, since it is not easy to package for Linux and breaks our Debian packaging.
2023-10-09 14:52:37 -05:00
Jonathan Thomas
5d5121b886
Update docs:
...
- Added markdown extension
- Updated lots of table column names
- Updated clip and effect description
- Made it more clear that transitions don't affect audio
- Reorganized some content under headings
- Shortened intro features list
- Updated "clean install" instructions
- Added profiles summary
2023-08-13 22:55:20 -05:00
Jonathan Thomas
8ce7e216ea
Fixing documentation issues (conf.py warnings, // to https warning, and extlinks warnings from missing %s, invalid title underline)
2022-12-11 13:25:45 -06:00
Jonathan Thomas
96612ccb7a
Updating PDF copyright to OpenShot Studios, LLC. Adding black banner graphic to introduction.rst, and adding screenshot to index.rst (to quickly give context when user manual loads)
2022-11-22 17:41:34 -06:00
Jonathan Thomas
f11d1d678b
Changing embedded XML output to a screenshot (so it prints better). Removing SVG from docs, since it breaks PDF generation. Adding some Latex options to remove blank pages from the PDF. Adding PDF generation to our GitLab builder.
2022-11-21 15:14:19 -06:00
Frank Dana
bbcb8c09a4
Docs: Add Sphinx directive for youtube embeds ( #3394 )
...
Add a simple directive `.. youtube`, implemented as a local sphinx
extension, that takes one argument — either:
- A YouTube video ID (e.g. `aqz-KE-bpKQ`)
- A YouTube URL (e.g. `https://www.youtube.com/watch?v=aqz-KE-bpKQ `)
In either case, when generating HTML docs the directive will be
replaced with an HTML embed of the video content.
Valid forms for the URL include at least:
- https://www.youtube.com/watch?v=YOUTUBE_ID
- https://www.youtube.com/embed/YOUTUBE_ID
- https://youtu.be/YOUTUBE_ID
Features like start time (`?t=45`) are currently not supported.
2020-04-28 09:44:03 -04:00
Frank Dana
accfd6a137
Move manual logo to xdg dir ( #3320 )
2020-03-27 00:02:41 -04:00
FeRD (Frank Dana)
5925707a1b
User Guide: Formatting, link updates
...
- Add `sphinx.ext.extlinks` extension, and use for repetetive links
- Conditionally enable `sphinx_copybutton` if found
- Wrap inline literals with double \` pairs, to format monospaced
- Turn developer page OS note into a Warning box, and replace the
outdated PDF install instructions link with links to the Windows
and Mac build instructions in the libopenshot project wiki
- Wrap paragraphs at periods or commas (sentence-per-line) instead of
arbitrarily fitting to a certain width
- Use shorter sentences where possible
2019-12-25 09:16:31 -05:00
FeRD (Frank Dana)
2c81cf5e56
Don't manually copy images to _static
2018-03-06 03:46:09 -05:00
FeRD (Frank Dana)
b62c74899c
Add tablefix.css to enable wrapping in table cells
2018-02-11 12:31:58 -05:00
Jonathan Thomas
1676e6088a
Integrating new user guide into main menu, and adding a custom footer and favicon to the documentation.
2017-03-24 04:22:02 -05:00
Jonathan Thomas
e724c24f36
Updated user guide / help manual
2016-10-04 01:36:49 -05:00
Jonathan Thomas
42e4f3aa89
Adding initial draft of user manual created with sphinx.
2016-09-23 01:20:02 -05:00
