Skip to content

Commit

Permalink
doc: remove secondary index for latex
Browse files Browse the repository at this point in the history
We are not building PDF documentation and it's TOC has become out of
sync with HTML one years ago. So apparently nobody needs this and nobody
noticed it is not complete.
  • Loading branch information
nijel committed Nov 26, 2024
1 parent 62903d5 commit 155ef8f
Show file tree
Hide file tree
Showing 10 changed files with 100 additions and 131 deletions.
2 changes: 1 addition & 1 deletion docs/admin/install/steps/install-configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Configuring Weblate
to :file:`~/weblate-env/lib/python3.9/site-packages/weblate/settings.py`.

#.
.. include:: steps/adjust-config.rst
.. include:: /admin/install/steps/adjust-config.rst

#. Create the database and its structure for Weblate (the example settings use
PostgreSQL, check :ref:`database-setup` for a production-ready setup):
Expand Down
6 changes: 1 addition & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ def setup(app) -> None:
"_build",
"Thumbs.db",
".DS_Store",
"admin/install/steps/*.rst",
"devel/reporting-example.rst",
]

Expand Down Expand Up @@ -132,7 +131,6 @@ def setup(app) -> None:
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["../weblate/static/"]


html_logo = "../weblate/static/logo-128.png"


Expand Down Expand Up @@ -189,9 +187,7 @@ def setup(app) -> None:
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
("latexindex", "Weblate.tex", "The Weblate Manual", author, "manual")
]
latex_documents = [("index", "Weblate.tex", "The Weblate Manual", author, "manual")]

# Include logo on title page
latex_logo = "../weblate/static/logo-1024.png"
Expand Down
100 changes: 95 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,105 @@

.. include:: ../README.rst

.. include:: toc-user.rst
.. toctree::
:caption: User docs
:maxdepth: 1

.. include:: toc-admin.rst
user/basic
user/profile
user/translating
user/files
user/glossary
user/checks
user/search
workflows
faq
formats
vcs
api
wlc
python

.. include:: toc-devel.rst

.. include:: toc-contrib.rst
.. toctree::
:caption: Administrator docs
:maxdepth: 1

.. include:: toc-changes.rst
admin/install
admin/deployments
admin/upgrade
admin/backup
admin/auth
admin/access
admin/projects
admin/languages
admin/continuous
admin/licensing
admin/translating
admin/checks
admin/machine
admin/addons
admin/memory
admin/config
admin/sample
admin/management
admin/announcements
admin/componentlists
admin/optionals
admin/customize
admin/admin
admin/support
legal

.. toctree::
:caption: Application developer guide
:maxdepth: 1

devel/starting
devel/integration
devel/gettext
devel/sphinx
devel/html
devel/thirdparty
devel/alerts
devel/community
devel/translations
devel/review
devel/share
devel/reporting

.. toctree::
:caption: Contributor docs
:maxdepth: 1

contributing/index
contributing/communication
contributing/start
contributing/code
contributing/debugging
contributing/internals
contributing/addons
contributing/frontend
contributing/issues
contributing/tests

Check failure on line 85 in docs/index.rst

View workflow job for this annotation

GitHub Actions / Linkcheck

https://www.gnu.org/licenses/gpl-3.0.html: HTTPSConnectionPool(host='www.gnu.org', port=443): Max retries exceeded with url: /licenses/gpl-3.0.html (Caused by NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f75c57625d0>: Failed to establish a new connection: [Errno 101] Network is unreachable'))
contributing/schemas
contributing/release
contributing/security
contributing/modules
contributing/about
contributing/license
contributing/trademark

.. toctree::
:caption: Change history
:maxdepth: 1

changes
changes/v4
changes/v3
changes/v2
changes/v1
changes/v0

Indices and tables
------------------
Expand Down
24 changes: 0 additions & 24 deletions docs/latexindex.rst

This file was deleted.

29 changes: 0 additions & 29 deletions docs/toc-admin.rst

This file was deleted.

10 changes: 0 additions & 10 deletions docs/toc-changes.rst

This file was deleted.

21 changes: 0 additions & 21 deletions docs/toc-contrib.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/toc-devel.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/toc-user.rst

This file was deleted.

5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,9 @@ ignore = [

[tool.codespell]
count = true
ignore-words-list = "assertIn"
skip = '*.po,*.pot,*.json,*.tmx,*.tbx,*.csv,*/vendor/*,weblate/trans/specialchars.py,scripts/yarn/yarn.lock,weblate/trans/tests/data/known_hosts,docs/user/checks.rst,docs/toc-devel.rst,docs/changes/contributors/*.rst'
# Vai is a language name
ignore-words-list = "assertIn,Vai"
skip = '*.po,*.pot,*.json,*.tmx,*.tbx,*.csv,*/vendor/*,weblate/trans/specialchars.py,weblate/trans/tests/data/known_hosts,docs/changes/contributors/*.rst,docs/index.rst'

[tool.coverage.paths]
source = [
Expand Down

0 comments on commit 155ef8f

Please sign in to comment.