-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
site_name: "Optimizely Python SDK" | ||
|
||
# This tells pydocmd which pages to generate from which Python modules, | ||
# functions and classes. At the first level is the page name, below that | ||
# is a tree of Python member names (modules, classes, etc.) that should be | ||
# documented. Higher indentation leads to smaller header size. | ||
generate: | ||
- api.md: | ||
- optimizely: | ||
- optimizely.optimizely.Optimizely+ # (+ to include members) | ||
- optimizely.notification_center++ | ||
- optimizely.helpers.enums.NotificationTypes | ||
- optimizely.event_dispatcher++ | ||
- optimizely.error_handler++ | ||
- optimizely.exceptions++ | ||
- optimizely.logger | ||
- optimizely.logger.BaseLogger+ | ||
- optimizely.logger.SimpleLogger+ | ||
- optimizely.logger.NoOpLogger+ | ||
- optimizely.user_profile | ||
- optimizely.user_profile.UserProfileService++ | ||
|
||
# MkDocs pages configuration. The `<<` operator is sugar added by pydocmd | ||
# that allows you to use an external Markdown file (eg. your project's README) | ||
# in the documentation. The path must be relative to current working directory. | ||
pages: | ||
- Home: index.md << ../README.md | ||
- Optimizely: | ||
- API: api.md | ||
|
||
# These options all show off their default values. You don't have to add | ||
# them to your configuration if you're fine with the default. | ||
docs_dir: sources | ||
gens_dir: _build/pydocmd # This will end up as the MkDocs 'docs_dir' | ||
site_dir: _build/site | ||
theme: readthedocs | ||
loader: pydocmd.loader.PythonLoader | ||
preprocessor: pydocmd.preprocessor.Preprocessor | ||
|
||
# Additional search path for your Python module. If you use Pydocmd from a | ||
# subdirectory of your project (eg. docs/), you may want to add the parent | ||
# directory here. | ||
additional_search_paths: | ||
- .. |