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.

Sign up for GitHub

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

Jump to bottom

bug: Fixes mdbook action #4345

Merged
merged 2 commits into from
Jan 8, 2024
Merged

bug: Fixes mdbook action #4345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28c64d1
Fixed action argument
maddeleine Jan 8, 2024
9c67402
docs change to test it works
maddeleine Jan 8, 2024
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
4 changes: 2 additions & 2 deletions .github/workflows/usage_guide.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ jobs:
uses: JamesIves/[email protected]
if: github.event_name == 'push'
with:
destination_dir: usage-guide
publish_dir: docs/usage-guide/book
target-folder: usage-guide
folder: docs/usage-guide/book

- name: Configure AWS credentials
uses: aws-actions/[email protected]
Expand Down
4 changes: 0 additions & 4 deletions docs/usage-guide/topics/ch01-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ The [VERSIONING.rst](https://github.com/aws/s2n-tls/blob/main/VERSIONING.rst) do

s2n-tls uses [Doxygen](https://doxygen.nl/index.html) to document its public API. The latest s2n-tls documentation can be found on [GitHub pages](https://aws.github.io/s2n-tls/doxygen/).

Documentation for older versions or branches of s2n-tls can be generated locally. To generate the documentation, install doxygen and run `doxygen docs/doxygen/Doxyfile`. The doxygen documentation can now be found at `docs/doxygen/output/html/index.html`.

Doxygen installation instructions are available at the [Doxygen](https://doxygen.nl/download.html) webpage.

The doxygen documentation should be used in conjunction with this guide.

## Examples
Expand Down
Loading