readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
7.99k stars 3.58k forks source link

Deprecation: stop auto-finding `conf.py`/`mkdocs.yml` from the repository #10637

Open humitos opened 1 year ago

humitos commented 1 year ago

We currently have code that automatically finds a conf.py on the repository when there is no sphinx.configuration defined ( (https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-configuration). We should remove this auto-finding and make sphinx.configuration to have a better default (like docs/conf.py) or make it always required.

Note: the same happens for mkdocs.yml and mkdocs.configuration

https://github.com/readthedocs/readthedocs.org/blob/a23bc260d57a213c33440b02017dcef59fa57a9e/readthedocs/projects/models.py#L944-L962

I created a Metabase query for and I found ~950 projects without specifying sphinx.configuration in the last 180 days.

agjohnson commented 5 months ago

It might also make sense to first inspect the number of projects that are flagged as spam. This could drop the number of projects considerably too.

humitos commented 3 months ago

I checked that query today and it returned ~400 projects only.

agjohnson commented 3 months ago

Is that 400 spam projects or 400 projects down from the original 950 projects? The query is stuck for me.

humitos commented 3 months ago

Total projects without filter then from spam

humitos commented 1 month ago

I checked this again today by making the query directly on the Telemetry database because Metabase times out when extending the date range:

SELECT
  DISTINCT data->'project'->>'slug' as slug
FROM
  "telemetry_builddata"
​WHERE
  NOT data->'config'->'user'->'sphinx' ? 'configuration'
;

Then, I filtered those slugs by "active" organizations and not spam projects. The results are:

The next steps here are:

agjohnson commented 3 weeks ago

In Q4 we should send some emails out.