diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..904eac227 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Docker image version +build: + image: testing + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index f7712980d..366ef5dc7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,7 +49,6 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] breathe_projects = { "libzim": "./xml" @@ -70,3 +69,5 @@ primary_domain = 'cpp' highlight_language = 'cpp' + +master_doc = 'index' diff --git a/include/zim/search.h b/include/zim/search.h index ae4c54627..f2a736452 100644 --- a/include/zim/search.h +++ b/include/zim/search.h @@ -139,14 +139,14 @@ class Query */ Query& setGeorange(float latitude, float longitude, float distance); - bool m_verbose { false }; - std::string m_query { "" }; - bool m_suggestionMode { false }; - - bool m_geoquery { false }; - float m_latitude { 0 }; - float m_longitude { 0 }; - float m_distance { 0 } ; + bool m_verbose = false; + std::string m_query = ""; + bool m_suggestionMode = false; + + bool m_geoquery = false; + float m_latitude = 0; + float m_longitude = 0; + float m_distance = 0; }; diff --git a/include/zim/search_iterator.h b/include/zim/search_iterator.h index feaeec327..50b1e20bd 100644 --- a/include/zim/search_iterator.h +++ b/include/zim/search_iterator.h @@ -30,7 +30,7 @@ namespace zim class SearchResultSet; class SearchIterator : public std::iterator { - friend class zim::SearchResultSet; + friend class SearchResultSet; public: SearchIterator(); SearchIterator(const SearchIterator& it);