Fixing GitHub Pages publishing (motis-project#26)

Author: Lucas-C

.github/workflows/unix.yml

@@ -165,7 +165,7 @@ jobs:
           cd docs
           doxygen
           sphinx-build -M html . _build
-          mv _build ../public
+          mv _build/html ../public
 
       - name: Deploy documentation onto GitHub Pages 🚀
         if: github.ref == 'refs/heads/master'

docs/README.md

@@ -1,6 +1,18 @@
-Documentation was originally setup following this tutorial:
+Documentation was originally setup in PR [#25](https://github.com/motis-project/utl/pull/25) following this tutorial:
 [Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake](https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/)
 
+The documentation is then published to GitHub Pages: <https://motis-project.github.io/utl/>
+
+[breathe](https://breathe.readthedocs.io) is used to insert Doxygen doc snippets
+into the Sphinx-generated documentation.
+
+List of supported directives: <https://breathe.readthedocs.io/en/latest/directives.html#directives>
+
+## Installing the necessary tools
+
+    apt install doxygen
+    pip install -r docs/requirements.txt
+
 ## Generating Doxygen documentation
 With CMake, from the root directory:
 

docs/index.rst

@@ -35,7 +35,7 @@ error
 Advanced usage
 ^^^^^^^^^^^^^^
 
-By default, ``logF()`` inserts the current filename & linenumber in the log line.
+By default, ``logF()`` inserts the current filename & line number in the log line.
 However, you can use ``log()`` to specify your own **context** ::
 
   log(info, "http.get.resource", "Details");

include/utl/logging.h

@@ -74,13 +74,13 @@ void log(log_level const level, char const* ctx,
 }  // namespace utl
 
 // clang-format off
-#define _CLANG_C_COMPILER clang-cl
+#define _IS_MSVC _MSC_VER && CMAKE_C_COMPILER != clang-cl
 // clang-format on
 
 /**
  * Shorthand to invoke utl::log without specifying the namespace
  */
-#if _MSC_VER && CMAKE_C_COMPILER != _CLANG_C_COMPILER
+#if _IS_MSVC
 #define log(level, ctx, fmt_str, ...) \
   utl::log(utl::log_level::##level, ctx, fmt_str, __VA_ARGS__)
 #else
@@ -91,7 +91,7 @@ void log(log_level const level, char const* ctx,
 /**
  * Invoke utl::log using the current C++ filename & line number as ctx
  */
-#if _MSC_VER && CMAKE_C_COMPILER != _CLANG_C_COMPILER
+#if _IS_MSVC
 #define logF(level, fmt_str, ...) \
   log(level, FILE_AND_LINE_SHORT, fmt_str, __VA_ARGS__)
 #else