13 Commits

Author SHA1 Message Date
FeRD (Frank Dana)
08e4ed428e INSTALL.md: Updates, cleanup
INSTALL.md: Add Python, ALSA, ASIO info

Markdown syntax

Get rid of OS-specific install docs

They were just direct copies from the libopenshot repo, and it's too
much of a pain keeping them in sync. libopenshot-audio doesn't really
warrant separate instructions for each OS.

INSTALL.md: Cleanup, more detail
2021-08-22 04:18:58 -04:00
FeRD (Frank Dana)
b7f69cef9c Docs: Switch from UseDoxygen to doxygen_add_docs
Since CMake 3.11, the supported method of integrating Doxygen into
CMake projects has been via the doxygen_add_docs() CMake function,
which (crucially) can be passed a target name to create and doesn't
rely on tons of hardcoding like our UseDoxygen.cmake and its
Doxyfile.in template did.

This means our docs (only) now require CMake 3.11 to generate, but it
allows Doxygen to be configured/used multiple times in the same CMake
configuration, removing a major barrier to superproject builds.

Also, made docs disableable via an ENABLE_AUDIO_DOCS option, and adopt
FeatureSummary into the build.

Remove Doxyfile.in template

CI: Don't autoinstall API docs

Delete Doxyfile.in

Docs: Use PROJECT_VERSION_FULL

Don't pre-process source files
2021-08-22 04:17:37 -04:00
Frank Dana
a86c0ec13c CMake: Create and install EXPORTED configuration (#118)
* Rename header to OpenShotAudio.h
* Rename, rewrite openshot-audio-demo
* CMake: EXPORT targets, other updates
* Add Config.cmake.in export template
* Add FindASIO.cmake for SDK discovery
* Install FindASIO.cmake with exported config
2021-04-18 18:48:22 -04:00
Darío Hereñú
b243937e26 Formatting fixes for INSTALL docs (#104) 2020-12-13 15:33:00 -05:00
FeRD (Frank Dana)
531e0cd2a9 Don't remove juce namespace 2019-06-30 23:45:54 -04:00
FeRD (Frank Dana)
acb3b0e2d3 Doygen: Include doc/*.md in docs
Also include the documentation MarkDown pages in the Doxygen docs.
These will show up as Related Pages in the interface.

* The formatting of `INSTALL-*.md` had to be changed some:
  - Doxygen doesn't support headings in bulleted lists (lines starting
    with `* ###`) -- I'm not even sure that's legal markdown. They were
    changed to just level 3 headings (lines starting with `###`).
  - ALL Windows paths in `INSTALL-WINDOWS.md` were wrapped in backticks,
    to prevent Doxygen parsing them as markup commands.
  - Level 1 headings were added to the top of the three install docs,
    giving them the title "Building libopenshot for ___(OS)___".
    Otherwise all three pages were titled "Getting Started".

* Separately, the table at the top of `HW-ACCEL.md` does not
  translate well to Doxygen. It will need further polishing. But the
  docs are all quite readable now.
2019-06-30 23:45:54 -04:00
FeRD (Frank Dana)
aab360c601 Doxygen: Update formatting from JUCE configs
Doxygen was having real trouble generating clean docs from
the JUCE sources, but their own website docs were generated
with Doxygen as well, and looked great.

Turns out, they preprocess their own source files before
generating docs from them. Borrowed their Python script to
munge the sources, and connected it up as a new target
dependency for `make doc`. It'll only run if the docs are
requested to be built, and `make clean` will clear out
the preprocessed sources if it's run.
2019-06-30 23:45:54 -04:00
Jonathan Thomas
f8cbb089ba Create INSTALL-WINDOWS.md 2019-02-08 15:43:14 -06:00
Jonathan Thomas
5482f54af6 Create INSTALL-MAC.md 2019-02-08 15:42:55 -06:00
Jonathan Thomas
8edcd43079 Create INSTALL-LINUX.md 2019-02-08 15:42:20 -06:00
Jonathan Thomas
c44d47069a update manpage 2012-08-09 12:26:59 -05:00
Jonathan Thomas
31fc5b76e9 Added manpage to audio project 2012-08-09 11:34:10 -05:00
Jonathan Thomas
c0e605fafe initial files in the openshot audio library 2012-06-15 17:45:27 -05:00