Skip to content
Open
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
9 changes: 0 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,3 @@ all:
bundle exec jekyll build
#bash deploy_benchmarking.sh

doxyjinj:
cd _doxygen_pretty && python3 doxyjinj.py struct_file.html ../_includes/liboqs/build/docs/xml/struct_o_q_s___k_e_m.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/oqskem.html
cd _doxygen_pretty && python3 doxyjinj.py struct_file.html ../_includes/liboqs/build/docs/xml/struct_o_q_s___s_i_g.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/oqssig.html
cd _doxygen_pretty && python3 doxyjinj.py struct_file.html ../_includes/liboqs/build/docs/xml/struct_o_q_s___s_i_g___s_t_f_l___s_e_c_r_e_t___k_e_y.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/oqssig_stfl_secret_key.html
cd _doxygen_pretty && python3 doxyjinj.py header_file.html ../_includes/liboqs/build/docs/xml/common_8h.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/common.html
cd _doxygen_pretty && python3 doxyjinj.py header_file.html ../_includes/liboqs/build/docs/xml/kem_8h.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/kem.html
cd _doxygen_pretty && python3 doxyjinj.py header_file.html ../_includes/liboqs/build/docs/xml/rand_8h.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/rand.html
cd _doxygen_pretty && python3 doxyjinj.py header_file.html ../_includes/liboqs/build/docs/xml/sig_8h.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/sig.html
cd _doxygen_pretty && python3 doxyjinj.py header_file.html ../_includes/liboqs/build/docs/xml/sig__stfl_8h.xml 'https://github.com/open-quantum-safe/liboqs/tree/main/' > ../liboqs/api/sig_stfl.html
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ git commit
```

## Rebuilding API documentation

```bash
make doxyjinj
```

Then clean up the diffs so that they have the YML header and don't have their own HTML header / footer.
API documentation is generated by Doxygen and served under the path `/liboqs/api/doxygen`.
A simple page is served at `/liboqs/api` to provide an explicit link to the documentation.
See [`gen-c-api-docs.sh`](./gen-c-api-docs.sh) for details.
194 changes: 0 additions & 194 deletions _doxygen_pretty/doxyjinj.py

This file was deleted.

1 change: 0 additions & 1 deletion _doxygen_pretty/templates/base/computeroutput

This file was deleted.

1 change: 0 additions & 1 deletion _doxygen_pretty/templates/base/para

This file was deleted.

3 changes: 0 additions & 3 deletions _doxygen_pretty/templates/base/verbatim

This file was deleted.

20 changes: 0 additions & 20 deletions _doxygen_pretty/templates/components/enums_card.html

This file was deleted.

6 changes: 0 additions & 6 deletions _doxygen_pretty/templates/components/enums_table.html

This file was deleted.

26 changes: 0 additions & 26 deletions _doxygen_pretty/templates/components/functions_card.html

This file was deleted.

8 changes: 0 additions & 8 deletions _doxygen_pretty/templates/components/functions_table.html

This file was deleted.

6 changes: 0 additions & 6 deletions _doxygen_pretty/templates/components/includes.html

This file was deleted.

22 changes: 0 additions & 22 deletions _doxygen_pretty/templates/components/macros.html

This file was deleted.

9 changes: 0 additions & 9 deletions _doxygen_pretty/templates/components/typedefs.html

This file was deleted.

8 changes: 0 additions & 8 deletions _doxygen_pretty/templates/components/variables_table.html

This file was deleted.

Loading
Loading