Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replacing Sphinx Build Action - with simpler approach #5418

Merged
merged 13 commits into from
Feb 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Github Actions workflow to generate documentation
# Uses the following shared task definitions:
# - (checkout, upload artifact) from Github
# - sphinx-action maintained by @ammaraskar
name: Sphinx build

# Controls when the action will run.
Expand All @@ -10,24 +9,21 @@ on:
- push
- pull_request

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps are a sequence of tasks that will be executed as part of the job
steps:
# Check out repository under $GITHUB_WORKSPACE
- uses: actions/checkout@v3
# Builds docs using sphinx
- uses: ammaraskar/sphinx-action@master
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v3
with:
docs-folder: "doc/"
pre-build-command: pip3 install sphinx_markdown_builder
# Create an artifact out of the generated HTML
python-version: '3.x'
- name: Install Sphinx & Dependencies
run: pip install sphinx sphinx_markdown_builder sphinx_rtd_theme
- name: Build Documentation
run: cd "$GITHUB_WORKSPACE/doc" && make html
- uses: actions/upload-artifact@v3
with:
name: UserGuideHTML
path: "doc/_build/html/"
name: Documentation
path: "$GITHUB_WORKSPACE/doc/_build/html/"

44 changes: 0 additions & 44 deletions AUTHORS

This file was deleted.

49 changes: 49 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Authors

*OpenShot Video Editor* is authored by **Jonathan Thomas** <[email protected]> and many
open-source developers, artists, translators, testers, and contributors. OpenShot is
managed by OpenShot Studios, LLC.

## Developers / Contributors:

**Creator & Lead Developer**: Jonathan Thomas <[email protected]>. See
`src/resources/contributors.json` for details on **all** developers & contributors.
These are also available in the `About->Credits` dialog.

## Translators:

See `src/language/` folder for details on translation credits. Each
translation contains a `translator-credits` key containing the
details of each translator that contributed to that language. These are also
available in the `About->Credits` dialog.

## Artists:

See `src/resources/contributors.json` for details on **all** the amazing artists
who contributed Creative Commons & open-source licensed images for our transitions,
icons, emojis, logos, and UI. These are also available in the `About->Credits` dialog.

## Fonts:

Canonical / Ubuntu (Ubuntu-R.ttf font)

## Emojis:

OpenMoji (http://openmoji.org/). All emojis designed by OpenMoji,
the open-source emoji and icon project. License: CC BY-SA 4.0

## Supporters:

A huge thanks to all the financial backers and supporters from PayPay,
Kickstarter, and Patreon! Details can be found in `src/resources/supporters.json`.
These are also available in the `About->Credits` dialog.

## GitHub & Launchpad Contributors:

For the full list of **developers** and **technical contributors**, please visit:

https://github.com/OpenShot/openshot-qt/graphs/contributors
https://github.com/OpenShot/libopenshot/graphs/contributors
https://github.com/OpenShot/libopenshot-audio/graphs/contributors
http://openshot.org/developers
https://launchpad.net/~openshot.developers
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# OpenShot Video Editor

OpenShot Video Editor is an award-winning free and open-source video editor
for Linux, Mac, and Windows, and is dedicated to delivering high quality
video editing and animation solutions to the world.
Expand Down
Loading