Skip to content
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

Docs/rearranging top level pages #3405

Closed
wants to merge 1 commit into from

Conversation

jacalata
Copy link
Contributor

@jacalata jacalata commented Jun 24, 2022

Summary of changes

Deleted setuptools.rst and redirected incoming links to index page

  • dropped Features list and Transition Note
  • moved setup.cfg-only section to setup.cfg page
  • moved Forum and Bug Tracker to index page
  • moved manifest note to data files page
  • moved Configuration API to Deprecated Functionalities?

Closes #3400

Pull Request Checklist

Deleted setuptools.rst and redirected incoming links to index page
- dropped Features list and Transition Note
- moved setup.cfg-only section to setup.cfg page
- moved Forum and Bug Tracker to index page
- moved manifest note to data files page
- moved Configuration API to Deprecated Functionalities?
@jacalata
Copy link
Contributor Author

test failure is unrelated, waiting for fix in #3410

@jacalata jacalata changed the title [WIP] Docs/rearranging top level pages Docs/rearranging top level pages Jun 25, 2022
@abravalheri
Copy link
Contributor

abravalheri commented Jun 25, 2022

Yes, thank you very much @jacalata .

I have some suggestions: jacalata#1

There is one comment about the redirect setup. I remember reading somewhere that the plugin setuptools is using for the redirects requires the dedtination address to have the .html extension. Could you please double check that?

@jaraco jaraco closed this Jul 4, 2022
@jaraco jaraco reopened this Jul 4, 2022
@@ -1,5 +1,5 @@
"Eggsecutable" Scripts
----------------------
=================
Copy link
Member

Choose a reason for hiding this comment

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

I recall that rst is strict about heading length matches, so will likely warn here (and fail in nitpicky mode). Let's keep the length consistent.


.. note:: TODO: inserted from "Building and Distributing Packages": is this still true?

versionadded:: 40.9.0
Copy link
Member

Choose a reason for hiding this comment

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

This line looks like it's meant to be a directive, but there's no ... Is that intentional?

Copy link
Member

Choose a reason for hiding this comment

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

Here's how it's rendering:

image

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
versionadded:: 40.9.0
.. versionadded:: 40.9.0

call is still required even if your configuration resides in ``setup.cfg``/``pyproject.toml``.


.. note:: TODO: inserted from "Building and Distributing Packages": is this still true?
Copy link
Member

Choose a reason for hiding this comment

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

Let's not add TODOs to the docs. Instead, file an issue describing the uncertainty and optionally link that issue in a comment that's not rendered in the output.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was hoping to figure this one out before submitting, it seems to mildly conflict with some other text.

@@ -1,5 +1,5 @@
"Eggsecutable" Scripts
----------------------
=================

Choose a reason for hiding this comment

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

Suggested change
=================
======================

@webknjaz
Copy link
Member

@jacalata looks like this PR needs rebasing

@jaraco jaraco force-pushed the main branch 3 times, most recently from a85759c to 93ce5a0 Compare December 16, 2022 18:21
@jaraco
Copy link
Member

jaraco commented Jun 21, 2023

This PR seems stale. I'm closing it, but feel free to engage on it again, including requesting to re-open or by re-submitting (presumably after addressing some or all of the concerns above).

@jaraco jaraco closed this Jun 21, 2023
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.

5 participants