Update docs generation #3
Open
Conversation
This file contains hidden or 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
Fixes warning
```
CMake Warning (dev) in CMakeLists.txt:
No project() command is present. The top-level CMakeLists.txt file must
contain a literal, direct call to the project() command. Add a line of
code such as
project(ProjectName)
near the top of the file, but after cmake_minimum_required().
CMake is pretending there is a "project(Project)" command on the first
line.
```
Fixes cmake warning ``` CMake Deprecation Warning at CMakeLists.txt:36 (CMAKE_MINIMUM_REQUIRED): Compatibility with CMake < 3.10 will be removed from a future version of CMake. Update the VERSION argument <min> value. Or, use the <min>...<max> syntax to tell CMake that the project requires at least <min> but has been updated to work with policies introduced by <max> or earlier. ```
To fix warning ``` CMake Warning (dev) at CMakeLists.txt:44 (find_package): Policy CMP0148 is not set: The FindPythonInterp and FindPythonLibs modules are removed. Run "cmake --help-policy CMP0148" for policy details. Use the cmake_policy command to set the policy and suppress this warning. ```
Resolves warning: ``` WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code. ```
Fixes warning: ``` WARNING: html_static_path entry '_static' does not exist ```
Fixes warning: ``` <rst_epilog>:1: WARNING: Substitution definition "version" empty or invalid. .. |version| replace: 1.8.9 [docutils] ```
Fixes warnings: ``` L:\Projects\Github\alembic-docs\sphinx\reference\abcm.rst:15: ERROR: Unknown target name: "coshader". [docutils] L:\Projects\Github\alembic-docs\sphinx\python\abcm.rst:15: ERROR: Unknown target name: "coshader". [docutils] ```
Fixes warnings: ``` L:\Projects\Github\alembic-docs\sphinx\python\examples.rst: WARNING: document isn't included in any toctree [toc.not_included] L:\Projects\Github\alembic-docs\sphinx\reference\index.rst: WARNING: document isn't included in any toctree [toc.not_included] ```
To make snippets reproducable without wildcard imports.
1) Used `find_package_handle_standard_args` to handle required variables automatically. It also handles `REQUIRED` keyword in `find_package` which previously had no effect, though it was used in cmake. 2) Simplified if statements a bit - `-NOTFOUND` variables evaluate to `FALSE` in cmake automatically.
Fixes warning below:
```
CMake Warning (dev) at CMakeLists.txt:51 (find_package):
Policy CMP0144 is not set: find_package uses upper-case <PACKAGENAME>_ROOT
variables. Run "cmake --help-policy CMP0144" for policy details. Use the
cmake_policy command to set the policy and suppress this warning.
CMake variable ALEMBIC_ROOT is set to:
L:\Software\usr\alembic
For compatibility, find_package is ignoring the variable, but code in a
.cmake module might still use it.
This warning is for project developers. Use -Wno-dev to suppress it.
```
Found when there was an issue with `FindAlembic` not handling `REQUIRED`, but I guess it wouldn't hurt to have this check always.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hi! Wanted to update docs and end up fixing many issues that accumulated by the years.
Each commit has some incremental change - I was also attaching fixed errors / warnings to the descriptions to make changes more clear. So it should be relatively easy to follow.
There are still some doxygen warnings/errors (and lots of "undocumented" warnings), but I'm not that familar with neither doxygen or alembic codebase to proceed with this.
doxygen warnings / errors
@lamiller0 can you please take a look?