Changes to reduce the size of published documentation on GitHub Pages #1499
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
UncleGrumpy
force-pushed
the
fix-publish-docs
branch
from
df99b58 to
d56af5c
Compare
|
LGTM! |
petermm
approved these changes
Jan 27, 2025
UncleGrumpy
added a commit
to UncleGrumpy/atomvm_www
that referenced
this pull request
Feb 18, 2025
Removes old v0.6.0 pre-release directories and temporarily adds a symlink to the v0.6.0 release documentation until atomvm/AtomVM#1499 is merged. Once these entries are removed from the menu these symlinks may be removed. Signed-off-by: Winford <winford@object.stream>
UncleGrumpy
added a commit
to UncleGrumpy/atomvm_www
that referenced
this pull request
Feb 18, 2025
This is a fix to reduce the size of the "Production" branch of this repo where the GitHub Pages that host the https://www.atomvm.net website. The production branch has far exceeded its size limit since the 0.6.5 release, and no further updates to the AtomVM documentation have been visible on-line since. Removes old v0.6.0 pre-release directories and temporarily adds a symlink to the v0.6.0 release documentation until atomvm/AtomVM#1499 is merged. Once these entries are removed from the menu these symlinks may be removed. Signed-off-by: Winford <winford@object.stream>
Adds the branchname to the commit message when pushing changes to the Production branch of atomvm_www to help keep a more sensible commit log. Signed-off-by: Winford <winford@object.stream>
Adds a missing check for doxygen required to sucessfully build the documentation. Signed-off-by: Winford <winford@object.stream>
Changes the generated images from PNG to SVG for size and better rendering on most browsers, and in the generated epub and pdf documents. Signed-off-by: Winford <winford@object.stream>
There were .doctree cache artifacts being included in the 'doc/html', 'doc/html/pdf', and 'doc/html/epub' folders that are only used during Sphinx generation of the content. Moves the location of these files to a common location in the build/doc folder outside of the html folder to be committed. This should have the added benefit of reducing the workload, since all three versions use can share the same cache files. Signed-off-by: Winford <winford@object.stream>
Removed the v0.5.0 and pre-release versions of v0.6.0 from the menu in the published documetation. This will direct users to more recent stable relese versions, and help keep the size of the "Production" branch of atomvm_www below the 1 GB limit for GitHub Pages branches. Note: the directories for these old version will be removed from the atomvm_www Production branch in a PR in that repo, these changes just prvent them from being incuded in the navigation menu. Signed-off-by: Winford <winford@object.stream>
UncleGrumpy
force-pushed
the
fix-publish-docs
branch
from
d56af5c to
e6499cb
Compare
pguyot
changed the title
bettio
approved these changes
Mar 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These changes take the first steps necessary to remove older and pre-release versions from the published documentation by removing these versions form the navigation menu. This directs users to recent stable releases, and helps keep the published pages below the 1 GB limit for GitHub hosted Pages branches.
Note: the old documentation versions will be removed from the atomvm_www Production branch in a PR to that repo.
Minor adjustment to graphics format from png to svg to keep sizes smaller and render better on a wider variety of browsers, and improve the quality of the PDF ans epub documents.
Changes to where build artifacts are created to keep them from polluting the published content and consuming unnecessary space.
Adds a missing check for doxgen before attempting to build the documentation.
These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later