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

Rename ref-api to ref-api-flwr #2730

Closed
wants to merge 3 commits into from
Closed

Rename ref-api to ref-api-flwr #2730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d97a28c
Rename ref-api to ref-api-flwr
adam-narozniak Dec 20, 2023
6207122
Merge branch 'main' into rename-api-docs-directory
tanertopal Dec 20, 2023
87a71d6
Merge branch 'main' into rename-api-docs-directory
tanertopal Dec 20, 2023
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 doc/build-versioned-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ END
# Restore branch as it was to avoid conflicts
git restore source/_templates
git restore source/_templates/autosummary || rm -rf source/_templates/autosummary
rm source/ref-api/*.rst
rm source/ref-api-flwr/*.rst

if [ "$current_version" = "v1.5.0" ]; then
git restore source/conf.py
Expand All @@ -103,7 +103,7 @@ for current_language in ${languages}; do
export current_language
sphinx-build -b html source/ build/html/${current_version}/${current_language} -A lang=True -D language=${current_language}
done
rm source/ref-api/*.rst
rm source/ref-api-flwr/*.rst

# Copy main version to the root of the built docs
cp -r build/html/main/en/* build/html/
2 changes: 1 addition & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ References
Information-oriented API reference and other reference material.

.. autosummary::
:toctree: ref-api
:toctree: ref-api-flwr
:template: autosummary/module.rst
:caption: API reference
:recursive:
Expand Down