diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b8cdeaa7..35ab30b4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -191,22 +191,16 @@ Make sure to do this at least once before your first commit to check your setup ## Contributing to the Documentation -We are glad to accept any sort of documentation: function docstrings, -reStructuredText documents, tutorials, etc. -reStructuredText documents live in the source code repository under the -doc/ directory. - -You can edit the documentation using any text editor and then generate -the HTML output by typing ``make html`` from the doc/ directory. -The resulting HTML files will be placed in ``build/html/`` and are viewable in -a web browser. See the ``README`` file in the ``doc/`` directory for more -information. - -For building the documentation, you will need to install a few additional dependencies: +We welcome all forms of documentation contributions — whether it's Markdown docstrings, tutorials, guides, or general improvements. + +Our documentation is written either in Markdown or as a jupyter notebook and lives in the docs/ and examples/ directories of the source code repository. + +To preview the documentation locally, you will need to install a few additional dependencies: ```bash uv pip install -e .[examples,docs] ``` When dependencies are installed, run ```bash -sphinx-build -b html doc YOUR_PREFERRED_OUTPUT_DIRECTORY +mkdocs serve ``` +This will open a preview of the website. \ No newline at end of file diff --git a/docs/images/openml_icon.png b/docs/images/openml_icon.png new file mode 100644 index 000000000..4808572ff Binary files /dev/null and b/docs/images/openml_icon.png differ diff --git a/mkdocs.yml b/mkdocs.yml index de3ca15e7..38d9fe05a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,9 @@ site_name: openml-python +repo_url: https://github.com/openml/openml-python +repo_name: openml/openml-python theme: + logo: images/openml_icon.png + favicon: images/openml_icon.png name: material features: - content.code.annotate @@ -11,6 +15,7 @@ theme: - navigation.tabs - navigation.tabs.sticky - header.autohide + - header.social - search.suggest - search.highlight - search.share