Skip to content

Removing unused RST files #32547

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

Merged
merged 2 commits into from
Oct 18, 2023
Merged

Removing unused RST files #32547

merged 2 commits into from
Oct 18, 2023

Conversation

lmazuel
Copy link
Member

@lmazuel lmazuel commented Oct 17, 2023

In strict sphinx mode, RST files that are unused are considered errors. The way we build on main index.md in prep_sphinx_env.py, we never use the lower level of the namespace files created by sphinx-apidoc (for instance azure.rst or azure.keyvault.rst), which creates a warning/error.

Using the namespace resolution from the setup.py, to remove files that we don't use.

Tested manually on identity and keyvault keys (so I get two packages with different levels).

Copy link
Member

@scbedd scbedd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️ thanks Laurent.

@lmazuel lmazuel merged commit bb81888 into main Oct 18, 2023
@lmazuel lmazuel deleted the sphinx_rst_clean branch October 18, 2023 18:28
iscai-msft added a commit to iscai-msft/azure-sdk-for-python that referenced this pull request Oct 19, 2023
…into update_package_json

* 'main' of https://github.com/Azure/azure-sdk-for-python: (136 commits)
  Re-record (Azure#32584)
  Update CODEOWNERS (Azure#32583)
  capture request data with aiohttp multipart/form-data (Azure#32543)
  [Core] Create generic azure-core package: `corehttp` (Azure#32191)
  overwrite .amlignore file (Azure#32546)
  Fix Sphinx error in core (Azure#32417)
  skip pyright for now (Azure#32569)
  Fix identity-broker sdist (Azure#32568)
  Updates to interactions with `pyproject.toml` (Azure#32480)
  fix: fixing local variable's name(last_modified_exising -> last_modified_existing) typo via Cspell (Azure#32556)
  Update feature store related entities to use the GA version (Azure#32541)
  Removing unused RST files (Azure#32547)
  Update python version for virtualenv issues (Azure#32528)
  [AutoRelease] t2-keyvault-2023-10-13-36681(can only be merged by SDK owner) (Azure#32478)
  [Monitor Distro] Update broken link (Azure#32505)
  Bump python stress images and addons (Azure#32554)
  Bump (Azure#32552)
  Increment package version after release of azure-cosmos (Azure#32550)
  repair aggregate report pipeline (Azure#32509)
  update readme and samples (Azure#32548)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants