Fix doc CMakeLists.txt

Author: pockerman

doc/CMakeLists.txt

@@ -4,9 +4,6 @@ IF (NOT DOXYGEN_FOUND)
 	return()
 ENDIF()
 
-
-SET(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs)
-
 # Configure Doxyfile
 SET(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
 SET(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
@@ -15,37 +12,11 @@ SET(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 SET(DOXYGEN_GENERATE_HTML YES)
 SET(DOXYGEN_GENERATE_XML NO)
 
-# don't generate documentation from implementation details
-#SET(DOXYGEN_EXCLUDE_PATTERNS "*/extern/*")
-
-# print paths relative to include directory
-#SET(DOXYGEN_STRIP_FROM_PATH "${PROJECT_SOURCE_DIR}/src/bitrl")
-
 configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
 
-
 add_custom_target(doc
 		COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
 		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 		COMMENT "Generating API documentation with Doxygen..."
 		VERBATIM
 )
-
-# Note: use doxygen_add_docs(doxygen-doc ALL ...) if you want your documentation
-# to be created by default each time you build. Without the keyword you need to
-# explicitly invoke building of the 'doc' target.
-#doxygen_add_docs(doxygen-doc ${PROJECT_SOURCE_DIR}/src/bitrl COMMENT "Generating API documentation with Doxygen")
-#
-#
-#configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in
-#               ${CMAKE_CURRENT_BINARY_DIR}/conf.py @ONLY)
-#
-#add_custom_target(
-#  sphinx-doc ALL
-#  COMMAND ${SPHINX_EXECUTABLE} -b html -c ${CMAKE_CURRENT_BINARY_DIR}
-#          ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}
-#  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-#  COMMENT "Generating API documentation with Sphinx"
-#  VERBATIM)
-#
-#add_dependencies(sphinx-doc doxygen-doc)

doc/Doxyfile.in

@@ -1,17 +1,19 @@
 #---------------------------------------------------------------------------
 
 PROJECT_NAME           = "@PROJECT_NAME@"
-OUTPUT_DIRECTORY       = "@DOXYGEN_OUTPUT_DIR@"
+OUTPUT_DIRECTORY       = @PROJECT_SOURCE_DIR@/docs
 GENERATE_LATEX         = NO
 RECURSIVE              = YES
 
 # Adjust to your source path(s)
-INPUT                  = @PROJECT_SOURCE_DIR@/src/bitrl
+INPUT                  = @PROJECT_SOURCE_DIR@/src/bitrl @PROJECT_SOURCE_DIR@/doc
 
-FILE_PATTERNS          = *.h *.hpp *.cpp
+FILE_PATTERNS          = *.h *.hpp *.cpp *.md
 
 GENERATE_HTML          = YES
 HTML_OUTPUT            = .
+# Use a Markdown file as the main page
+USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/doc/index.md
 
 EXTRACT_ALL            = YES
 EXCLUDE = @PROJECT_SOURCE_DIR@/src/bitrl/extern

doc/index.md

@@ -0,0 +1,113 @@
+# bitrl
+
+```bitrl``` is an effort to provide implementations and wrappers of environments suitable for training reinforcement learning agents
+using  C++.
+
+Furthermore, there is some minimal support for working with Arduino UNO boards over USB or WiFi.
+See also <a href="https://rlenvscpp.readthedocs.io/en/latest/working_with_webots.html">Working with Webots</a>
+for how to integrate ```bitrl``` with <a href="https://cyberbotics.com/doc/guide/installing-webots">Webots</a>.
+
+Various RL algorithms using the environments can be found at <a href="https://github.com/pockerman/cuberl/tree/master">cuberl</a>.
+
+The documentation for the library can be found <a href="https://rlenvscpp.readthedocs.io/en/latest/">here</a>.
+The following is an example how to use the
+``FrozenLake``   environment from <a href="https://github.com/Farama-Foundation/Gymnasium/tree/main">Gymnasium</a>.
+
+```
+
+#include "bitrl/bitrl_types.h"
+#include "bitrl/envs/gymnasium/toy_text/frozen_lake_env.h"
+#include "bitrl/envs/api_server/apiserver.h"
+
+#include <iostream>
+#include <string>
+#include <unordered_map>
+#include <any>
+
+namespace example_1{
+
+const std::string SERVER_URL = "http://0.0.0.0:8001/api";
+
+using bitrl::envs::gymnasium::FrozenLake;
+using bitrl::envs::gymnasium::Taxi;
+using bitrl::envs::gymnasium::BlackJack;
+using bitrl::envs::gymnasium::CliffWorld;
+using bitrl::envs::RESTApiServerWrapper;
+
+
+void test_frozen_lake(const RESTApiServerWrapper& server){
+
+    FrozenLake<4> env(server);
+
+    std::cout<<"Environame URL: "<<env.get_url()<<std::endl;
+
+    // make the environment
+    std::unordered_map<std::string, std::any> options;
+    options.insert({"is_slippery", false});
+    env.make("v1", options);
+
+    std::cout<<"Is environment created? "<<env.is_created()<<std::endl;
+    std::cout<<"Is environment alive? "<<env.is_alive()<<std::endl;
+    std::cout<<"Number of valid actions? "<<env.n_actions()<<std::endl;
+    std::cout<<"Number of states? "<<env.n_states()<<std::endl;
+
+    // reset the environment
+    auto time_step = env.reset(42, std::unordered_map<std::string, std::any>());
+
+    std::cout<<"Reward on reset: "<<time_step.reward()<<std::endl;
+    std::cout<<"Observation on reset: "<<time_step.observation()<<std::endl;
+    std::cout<<"Is terminal state: "<<time_step.done()<<std::endl;
+
+    //...print the time_step
+    std::cout<<time_step<<std::endl;
+
+    // take an action in the environment
+	// 2 = RIGHT
+    auto new_time_step = env.step(2);
+
+    std::cout<<new_time_step<<std::endl;
+
+    // get the dynamics of the environment for the given state and action
+    auto state = 0;
+    auto action = 1;
+    auto dynamics = env.p(state, action);
+
+    std::cout<<"Dynamics for state="<<state<<" and action="<<action<<std::endl;
+
+    for(auto item:dynamics){
+
+        std::cout<<std::get<0>(item)<<std::endl;
+        std::cout<<std::get<1>(item)<<std::endl;
+        std::cout<<std::get<2>(item)<<std::endl;
+        std::cout<<std::get<3>(item)<<std::endl;
+    }
+	
+	action = env.sample_action();
+	std::cout<<"Action sampled: "<<action<<std::endl;
+	
+	new_time_step = env.step(action);
+    std::cout<<new_time_step<<std::endl;
+	
+	std::cout<<"env cidx: "<<env.cidx()<<std::endl;
+
+    // close the environment
+    env.close();
+}
+
+}
+
+
+int main(){
+
+	using namespace example_1;
+	
+	RESTApiServerWrapper server(SERVER_URL, true);
+
+    std::cout<<"Testing FrozenLake..."<<std::endl;
+    example_1::test_frozen_lake(server);
+    std::cout<<"===================="<<std::endl;
+  
+    return 0;
+}
+
+```