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

[WIP] Add configuration files for Sphinx/ReadTheDocs #838

Draft
wants to merge 46 commits into
base: main
Choose a base branch
from

Conversation

JF002
Copy link
Collaborator

@JF002 JF002 commented Nov 21, 2021

Following our discussion in #748, I open this PR to start working on the re-working of the documentation of the project:

  • The documentation (user documentation, developers documentation,...) is stored in this repo
  • It's processed by the documentation generator Sphinx and hosted on ReadTheDocs.
  • The URL https://docs.infinitime.io will point to the documentation on RTD (Done)

I created a new team doc-writer for contributors who focus on writing and maintaining the documentation of the project. I also invited @ncartron to join the project as the first member of this team.

The 'new' doc is in the folder docs while the old one is still untouched in doc. Ultimately, we will keep only one doc* folder.

NOTE : @Riksu9000 has already created a PR about the documentation (#810 ). It's certainly a good idea to take those changes into account! Let's review this PR asap!

@JF002 JF002 added the documentation Improvements or additions to documentation label Nov 21, 2021
@JF002 JF002 marked this pull request as draft November 21, 2021 14:56
@JF002 JF002 added this to the 1.8.0 milestone Nov 21, 2021
@JF002
Copy link
Collaborator Author

JF002 commented Dec 2, 2021

@ncartron A new PR was recently created with new improvements to the documentation we might want to integrate in the new documentation : #854

@ncartron
Copy link

ncartron commented Dec 3, 2021

@JF002 got it, I'll look at #854 and will integrate what makes sense in the new doc.

@ncartron
Copy link

Alright, I reviewed the changes in #854 and they are mostly in the dev part - I'll incorporate them once I am working on that part of the new documentation (I am still in the user documentation ATM).

@JF002 JF002 modified the milestones: 1.9.0, 1.10.0 Apr 2, 2022
pankajraghav changed his post to the subdomain blog
@JF002 JF002 mentioned this pull request Mar 27, 2023
@github-actions
Copy link

Build size and comparison to main:

Section Size Difference
text 409300B 0B
data 996B 0B
bss 63372B 0B

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants