is there a development roadmap?

65 views
Skip to first unread message

Doug Hellmann

unread,
Jun 13, 2017, 2:52:54 PM6/13/17
to sphinx-dev
I would like to get involved with future work on sphinx, and start by understanding the current plans, especially because it looks like, based on issue #3865 [1], there are some impending API changes that are going to affect several projects I work on.

Is there a wiki doc or mailing list thread or something I can start with to understand the current plans?

Thanks,

Konstantin Molchanov

unread,
Jun 14, 2017, 2:12:56 PM6/14/17
to sphinx-dev
Oh man, I would love to contribute too... If you have room for a documentarian/hobbyist Python developer, I'll be happy to take some issues.

Komiya Takeshi

unread,
Jun 17, 2017, 12:58:06 AM6/17/17
to sphin...@googlegroups.com
Hi Doug,

Unfortunately we don't have any roadmaps and plans...

About #3865, it is not an intentional change.
Certainly, we're going to move logging framework to Sphinx logging API
now. But old styled warn() methods are still available. So it is only
a bug (and fixed it just now).
http://www.sphinx-doc.org/en/stable/extdev/logging.html

Thanks,
Takeshi KOMIYA
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-dev+...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

Doug Hellmann

unread,
Jun 17, 2017, 4:20:51 PM6/17/17
to sphinx-dev


On Saturday, June 17, 2017 at 12:58:06 AM UTC-4, Komiya Takeshi wrote:
Hi Doug,

Unfortunately we don't have any roadmaps and plans...

OK. I am available to help with testing, especially if there are changes where you think there may be backwards incompatibility issues such as #3865. I have quite a few doc sets with custom extensions that I can run tests against. I will try to watch for beta releases, but if you would like to contact me directly that is OK, too.
 

About #3865, it is not an intentional change.
Certainly, we're going to move logging framework to Sphinx logging API
now. But old styled warn() methods are still available. So it is only
a bug (and fixed it just now).
http://www.sphinx-doc.org/en/stable/extdev/logging.html

Wonderful, thank you so much for fixing that quickly!

Doug

Komiya Takeshi

unread,
Jun 18, 2017, 11:25:09 AM6/18/17
to sphin...@googlegroups.com
> OK. I am available to help with testing, especially if there are changes
> where you think there may be backwards incompatibility issues such as #3865.
> I have quite a few doc sets with custom extensions that I can run tests
> against. I will try to watch for beta releases, but if you would like to
> contact me directly that is OK, too.

Thank you for your offer. That would be nice :-)

According to our deprecation policy, we will announce and warn about
deprecation during a major version at least.
So I can promise you not break compatibility suddenly if you use
public Sphinx API.
(Of course, internal structure might be changed.)
https://github.com/sphinx-doc/sphinx/blame/master/CONTRIBUTING.rst#L313

Thanks,
Takeshi KOMIYA
Reply all
Reply to author
Forward
0 new messages