Skip to content

Commit fe2b634

Browse files
committed
[py] Update docs README and remove Makefile
1 parent 8fdc63a commit fe2b634

File tree

3 files changed

+4
-142
lines changed

3 files changed

+4
-142
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ py/selenium/webdriver/remote/isDisplayed.js
7676
py/docs/build/
7777
py/docs/source/**/*
7878
!py/docs/source/conf.py
79+
!py/docs/source/*.rst
7980
py/build/
8081
py/LICENSE
8182
py/pytestdebug.log

py/docs/Makefile

Lines changed: 0 additions & 131 deletions
This file was deleted.

py/docs/README.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,22 +49,14 @@ and develop the Python docs.
4949
To clean up the build assets and tox cache
5050
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5151

52-
Although there is a Sphinx Makefile option, to clean up using the tox environment above, one can
53-
manually clean the build assets by deleting the ``build`` directory on the root (``selenium/build``
54-
using the default directory on git clone). Note that tox caches parts of the build and recognizes
55-
changes to speed up the build. To start fresh, delete the aformentioned directory to clean the
56-
Sphinx build assets and delete the ``selenium/py/.tox`` directory to clean the tox environment.
52+
After using the tox environment above, you can clean up the build assets by deleting the ``build``
53+
directory in the root of the repo. Note that tox caches parts of the build and recognizes changes
54+
to speed up the build. To start fresh, delete the ``py/.tox`` directory to clean the tox environment.
5755

5856

5957
Known documentation issues
6058
==========================
6159

62-
The API Reference primarily builds from the source code. But currently the initial template stating
63-
which modules to document is hard coded within ``py/docs/source/api.rst``. So if modules are added or
64-
removed, then the generated docs will be inaccurate. It would be preferred that the API docs generate
65-
soley from the code if possible. This is being tracked in
66-
`#14178 <https://github.com/SeleniumHQ/selenium/issues/14178>`_
67-
6860
We are working through the Sphinx build warnings and errors, trying to clean up both the syntax and
6961
the build.
7062

0 commit comments

Comments
 (0)