cleaned up/renamed docs

benjaminjack · benjaminjack · commit f018febb94c4 · 2017-06-07T15:08:30.000-05:00
diff --git a/docs/cpp_code.rst b/docs/cpp_code.rst
@@ -0,0 +1,4 @@
+C++ code
+===================
+
+.. doxygenfile:: main.hpp 
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,17 @@
-Welcome to Python-CPP Example's documentation!
-==============================================
+Example documentation for a hybrid Python/C++ project
+=====================================================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   python_cpp_example
+   python_code
 
-.. doxygenfunction:: add
+   cpp_code
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
diff --git a/docs/python_code.rst b/docs/python_code.rst
diff --git a/python_cpp_example/bindings.cpp b/python_cpp_example/bindings.cpp
@@ -6,7 +6,7 @@ namespace py = pybind11;
 PYBIND11_PLUGIN(python_cpp_example)
 {
     py::module m("python_cpp_example", R"doc(
-        Pybind11 example plugin
+        Python module
         -----------------------
         .. currentmodule:: python_cpp_example
         .. autosummary::
@@ -18,19 +18,15 @@ PYBIND11_PLUGIN(python_cpp_example)
 
     m.def("add", &add, R"doc(
         Add two numbers
-        Some other explanation about the add function.
+        
+        Some other information about the add function.
     )doc");
 
     m.def("subtract", &subtract, R"doc(
         Subtract two numbers
-        Some other explanation about the subtract function.
-    )doc");
 
-#ifdef VERSION_INFO
-    m.attr("__version__") = py::str(VERSION_INFO);
-#else
-    m.attr("__version__") = py::str("dev");
-#endif
+        Some other information about the subtract function.
+    )doc");
 
     return m.ptr();
 }
diff --git a/python_cpp_example/main.hpp b/python_cpp_example/main.hpp
@@ -1,4 +1,10 @@
-/*! Add two integers woo! */
+/*! Add two integers
+    \param i an integer
+    \param j another integer
+*/
 int add(int i, int j);
-/*! Subtract one integer from another */
+/*! Subtract one integer from another 
+    \param i an integer
+    \param j an integer to subtract from \p i
+*/
 int subtract(int i, int j);
