the docs are not quite up-to-date and generates warnings

Aperta
#3 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
50/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
cmake, cpp

Direzione di ricerca

Esegui make docs e controlla gli avvisi segnalati per docs/building.md, docs/dependencies.md e docs/docker.md. Inizia dalle righe referenziate e dal markup della documentazione circostante, quindi ricostruisci la documentazione. Il lavoro è completato quando gli avvisi elencati di invalid-list, nesting e unresolved-reference non compaiono più.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation
bash-3.2$ make docs 
cmake ./ -B ./build -G "Ninja Multi-Config" -DCMAKE_BUILD_TYPE:STRING=Debug -DFEATURE_DOCS:BOOL=ON -DFEATURE_TESTS:BOOL=OFF
-- vcpkg is already installed at /Users/clausklein/vcpkg.
-- Running vcpkg install
Detecting compiler hash for triplet x64-osx...
The following packages will be built and installed:
    fmt[core]:x64-osx -> 8.1.1#1 -- /Users/clausklein/vcpkg/buildtrees/versioning_/versions/fmt/602d9743b7957c9e82a06d0e81d58637c6df5222
  * vcpkg-cmake[core]:x64-osx -> 2022-01-19 -- /Users/clausklein/vcpkg/buildtrees/versioning_/versions/vcpkg-cmake/b7c050fe60f91dcedef6d87a3f87584151bf8aee
  * vcpkg-cmake-config[core]:x64-osx -> 2022-02-06 -- /Users/clausklein/vcpkg/buildtrees/versioning_/versions/vcpkg-cmake-config/24dc7dfc704406e9f745f033643dc25f56e4ca18
Additional packages (*) will be modified to complete this operation.
Restored 3 packages from /Users/clausklein/.cache/vcpkg/archives in 31.4 ms. Use --debug to see more details.
Starting package 1/3: vcpkg-cmake-config:x64-osx
Installing package vcpkg-cmake-config[core]:x64-osx...
Elapsed time for package vcpkg-cmake-config:x64-osx: 1.857 ms
Starting package 2/3: vcpkg-cmake:x64-osx
Installing package vcpkg-cmake[core]:x64-osx...
Elapsed time for package vcpkg-cmake:x64-osx: 3.244 ms
Starting package 3/3: fmt:x64-osx
Installing package fmt[core]:x64-osx...
Elapsed time for package fmt:x64-osx: 9.997 ms

Total elapsed time: 1.783 s

The package fmt provides CMake targets:

    find_package(fmt CONFIG REQUIRED)
    target_link_libraries(main PRIVATE fmt::fmt)

    # Or use the header-only version
    find_package(fmt CONFIG REQUIRED)
    target_link_libraries(main PRIVATE fmt::fmt-header-only)

-- Running vcpkg install - done
-- The CXX compiler identification is AppleClang 13.1.6.13160021
-- The C compiler identification is AppleClang 13.1.6.13160021
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- The default CMAKE_CXX_STANDARD used by external targets and tools is not set yet. Using the latest supported C++ standard that is 20
-- The default CMAKE_C_STANDARD used by external targets and tools is not set yet. Using the latest supported C standard that is 17
-- /usr/local/bin/ccache found and enabled
-- Found Doxygen: /usr/local/bin/doxygen (found version "1.9.3") found components: doxygen dot 
-- Adding `doxygen-docs` target that builds the documentation.
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/clausklein/Workspace/cpp/cpp_cmake_project/build
cmake --build ./build --target doxygen-docs --config Debug
[1/1] Generating documentation - entry file: /Users/clausklein/Workspace/cpp/cpp_cmake_project/build/html/index.html
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/building.md:79: warning: Invalid list item found
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:14: warning: unable to resolve reference to 'docker-instructions' for \ref command
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:52: warning: found </details> at different nesting level (12) than expected (9)
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:77: warning: found </details> at different nesting level (12) than expected (9)
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:121: warning: found </details> at different nesting level (9) than expected (6)
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:144: warning: found </details> at different nesting level (10) than expected (7)
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:163: warning: found </details> at different nesting level (10) than expected (7)
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:182: warning: found </details> at different nesting level (10) than expected (7)
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:216: warning: end of comment block while expecting command </details>
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:216: warning: end of comment block while expecting command </details>
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:216: warning: end of comment block while expecting command </details>
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:216: warning: end of comment block while expecting command </details>
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:216: warning: end of comment block while expecting command </details>
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/dependencies.md:216: warning: end of comment block while expecting command </details>
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/docker.md:12: warning: unable to resolve reference to 'dependencies' for \ref command
/Users/clausklein/Workspace/cpp/cpp_cmake_project/docs/docker.md:45: warning: unable to resolve reference to 'build' for \ref command
bash-3.2$ 
Lingua principale
CMake
Stelle
44
Fork
8
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Nessun Dockerfile né file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aminya/cpp_vcpkg_project

Tutte le issue di aminya/cpp_vcpkg_project

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.