Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation generation #598

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -70,3 +69,5 @@
primary_domain = 'cpp'

highlight_language = 'cpp'

master_doc = 'index'
16 changes: 8 additions & 8 deletions include/zim/search.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};


Expand Down
2 changes: 1 addition & 1 deletion include/zim/search_iterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ namespace zim
class SearchResultSet;
class SearchIterator : public std::iterator<std::bidirectional_iterator_tag, Entry>
{
friend class zim::SearchResultSet;
friend class SearchResultSet;
public:
SearchIterator();
SearchIterator(const SearchIterator& it);
Expand Down