9 Commits

Author SHA1 Message Date
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
85806c7a0a Update docs:
- replace "decent" with "modern" phrasing
- standardize headers for AI consumption
2023-08-09 15:10:08 -05:00
Jonathan Thomas
8140d652da More updates:
- Wording updates / minor formatting
- Added "Type" to clip properties table
- Added notes that OpenShot does not support audio recording
- Renamed performance to playback page
- Added audio sync / audio device notes
- Added min blender version
2023-08-07 23:15:01 -05:00
Jonathan Thomas
704e54665d Updating table column widths to work better for PDF output (as well as HTML). Updating export-profiles.jpg screenshot and profiles.jpg with 4K updated one. Fixed many href/links to use more generic :ref: syntax... so the links work in both the PDF and HTML output. 2022-11-22 16:40:55 -06:00
Jonathan Thomas
101b1a430b Adding getting_started.rst from Shawn, and adding it to the index 2022-11-21 10:09:31 -06:00
Sebastian Spaeth
78469bf022 Improve Documentation
This is a smallish attempt to improve openshot's sparse documentation
(issue #2989).
The getting started page only contains an installation description, so name
it so. Improve the quick tutorial somewhat (at least according to my taste)
but still keep it quick. Improve the start of the "Files" pages somewhat.

Make the import files table more consistent by nameing the method in the
first column and actually describing them in a full senctence (interpunction)
in the 2nd column. Add the actual toolbar button icon image to the table.

Similar things for the slice clips table on the clips page.
2020-12-01 19:36:35 +01: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
Jonathan Thomas
aa19fbc006 Adding new user guide sections for files, titles, and transitions 2017-03-24 18:23:06 -05:00
Jonathan Thomas
42e4f3aa89 Adding initial draft of user manual created with sphinx. 2016-09-23 01:20:02 -05:00