Skip to content

Some docs work #158

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 18 commits into from
Mar 8, 2021
Merged

Some docs work #158

merged 18 commits into from
Mar 8, 2021

Conversation

Pike
Copy link
Contributor

@Pike Pike commented Nov 16, 2020

I have a few ideas on how to clean up and improve the docs tooling.

@Pike Pike force-pushed the docs-work branch 10 times, most recently from 7c587de to 0307b25 Compare November 18, 2020 20:42
@Pike Pike force-pushed the docs-work branch 2 times, most recently from b1a9751 to 7c23a57 Compare December 16, 2020 11:45
@Pike
Copy link
Contributor Author

Pike commented Dec 18, 2020

So one of the things I'd like to get to is versioned docs (like on rtd). That requires a healthy amount of actual code, which isn't great to put into the build-docs script.

I'm leaning towards refactoring the code into fluent.docs. Cons: It feels like people using Fluent would be interested in it. Pros: It's a unique name for the python tooling around the docs. And I haven't come up with a better place.

@zbraniecki , any opinions and/or suggestions? @stasm ?

Side note: the current state of this branch is already a good improvement, I chopped a bit of dead wood, and there's automation to publish the docs. I wouldn't want to merge this before the github-pages-deploy-action has its v4 release, but that should come soon. The current state of the PR points to an in-development branch.

Pike added 3 commits December 20, 2020 17:48
@Pike
Refactor actual docs build code into fluent.docs
aaaae96
@Pike
factor build into its own module
fdd396f
@Pike
Refactor build code.
5281b51 
Use classes for builders, use subclassing instead of code-flow
ifs to distinguish the top-level builder from the project builders.

This is in preparation for doing project builders per version.
@Pike
Copy link
Contributor Author

Pike commented Dec 25, 2020

I'm going with fluent.docs for now, mostly because I have cycles to spare. In the end, this is probably easy to move/rename as a whole.

@Pike Pike marked this pull request as ready for review February 22, 2021 16:45
@Pike
Copy link
Contributor Author

Pike commented Feb 22, 2021

Hi @zbraniecki , this is ready for review now. The generated docs are up on https://pike.github.io/python-fluent/fluent.runtime/stable/ etc for you to also have access to how this renders.

There's a few visual fixes that come with the updated sphinx and pygments versions, and the version picker, of course.

@Pike Pike requested a review from zbraniecki March 2, 2021 21:42
zbraniecki
zbraniecki approved these changes Mar 4, 2021
View reviewed changes
Copy link
Collaborator

@zbraniecki zbraniecki left a comment

Choose a reason for hiding this comment

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

lgtm

@Pike Pike merged commit 7b73fde into projectfluent:master Mar 8, 2021
@Pike
Copy link
Contributor Author

Pike commented Mar 8, 2021

Merged, and docs deployed themselves gracefully.

@Pike Pike deleted the docs-work branch March 8, 2021 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zbraniecki zbraniecki zbraniecki approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Pike @zbraniecki